diff --git a/README.md b/README.md index 4850a59b..fad93f94 100644 --- a/README.md +++ b/README.md @@ -1,26 +1,26 @@ -# βš•οΈπŸ§¬πŸ”¬Curieo Heathcare Search Backend Project πŸ” +# βš•οΈπŸ§¬πŸ”¬Curieo Healthcare Search Backend Project πŸ” ![Current Version](https://img.shields.io/badge/version-v0.1-blue) ![GitHub Org's stars](https://img.shields.io/github/stars/curieo-org) ![Website](https://img.shields.io/website?url=http%3A%2F%2Fcurieo.org%2F) - Welcome to Curieo Search, the search engine on a mission to revolutionize how you access healthcare information. Our goal is simple yet ambitious: to be the best healthcare search engine available, offering unparalleled access to accurate, up-to-date, and relevant medical information. ## Table of Contents -- [Getting Started](#getting-started) - - [Tools Required](#tools-required) - - [Installation](#installation) -- [Running the App](#running-the-app) -- [Deployment](#deployment) -- [Versioning](#versioning) + +- [Getting Started](#getting-started) + - [Tools Required](#tools-required) + - [Installation](#installation) +- [Running the App](#running-the-app) +- [Deployment](#deployment) +- [Versioning](#versioning) ## Getting Started The project might have multiple branches: `master`, `development`, etc. which can be explained here -* `master` contains aggregate code of all branches -* `development` contains code under development +- `master` contains aggregate code of all branches +- `development` contains code under development ``` search @@ -32,7 +32,7 @@ The project might have multiple branches: `master`, `development`, etc. which ca β”‚ β”œβ”€β”€ index.html β”‚ └── manifest.json └── app - β”œβ”€β”€ api + β”‚ β”œβ”€β”€ api β”‚ β”œβ”€β”€ common β”‚ β”œβ”€β”€ endpoints β”‚ β”‚ β”œβ”€β”€ search_endpoint.py @@ -42,7 +42,7 @@ The project might have multiple branches: `master`, `development`, etc. which ca β”‚ β”œβ”€β”€ router β”‚ β”œβ”€β”€ gzip.py β”‚ β”œβ”€β”€ api.py - β”œβ”€β”€ middlewere + β”œβ”€β”€ middleware β”œβ”€β”€ process_time.py β”œβ”€β”€ App.js β”œβ”€β”€ App.test.js @@ -55,25 +55,24 @@ The project might have multiple branches: `master`, `development`, etc. which ca ### Tools Required -* A text editor or an IDE (VsCode is Preferred) +- A text editor or an IDE (VsCode is Preferred) ### Installation All installation steps go here. -* Installing a particular tool - * Steps to complete it - -* Installing another tool +- Installing a particular tool + - Steps to complete it +- Installing another tool ## Running the App Steps and commands for running the app are to be included here -* Example steps: - ``` - Example command - ``` +- Example steps: + ``` + Example command + ``` ## Deployment @@ -81,4 +80,4 @@ This section is completely optional. Add additional notes about how to deploy th ## Versioning -`0.0.1` : +`0.0.1` :