docs: update README.md

StartUpNationLabs · Jul 15, 2024 · 661d18e · 661d18e
1 parent a0f0bae
commit 661d18e
Showing 1 changed file with 59 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
     <img src="https://upload.wikimedia.org/wikipedia/commons/c/cf/Transiting_Exoplanet_Survey_Satellite_artist_concept_%28black_background%29.png" >
   </a>
 
-  <h3 align="center">Satellite Information API</h3>
+<h3 align="center">Satellite Information API</h3>
 
   <p align="center">
     An API to calculate and retrieve information about satellites orbiting the Earth.
@@ -54,11 +54,14 @@
 </details>
 
 <!-- ABOUT THE PROJECT -->
+
 ## About The Project
 
-This project provides a comprehensive API to calculate and retrieve information about satellites orbiting the Earth. It includes endpoints to get detailed satellite information, groups, minimal data, and positions.
+This project provides a comprehensive API to calculate and retrieve information about satellites orbiting the Earth. It
+includes endpoints to get detailed satellite information, groups, minimal data, and positions.
 
 Here's why:
+
 * Accurate and up-to-date information on satellites.
 * Simplified access to satellite data through RESTful endpoints.
 * Easy integration into existing applications.
@@ -72,6 +75,7 @@ Here's why:
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- GETTING STARTED -->
+
 ## Getting Started
 
 To get a local copy up and running, follow these simple steps.
@@ -82,6 +86,20 @@ To get a local copy up and running, follow these simple steps.
   ```sh
   go install
   ```
+* Buf (for protobuf)
+  ```sh
+  brew tap bufbuild/buf
+  brew install buf
+  ```
+* Protoc (for protobuf)
+  ```sh
+  brew install protobuf
+  ```
+* Buf generate(To regenerate the protobuf files)
+  ```sh
+  buf generate
+  ```
+
 
 ### Installation
 
@@ -101,15 +119,19 @@ To get a local copy up and running, follow these simple steps.
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- USAGE EXAMPLES -->
+
 ## Usage
 
 Use this space to show useful examples of how this API can be used. Here are some example endpoints and responses:
 
 ### Get Satellite Detail
+
 ```sh
 GET /v1/satellite/detail/{id}
 ```
+
 Response:
+
 ```json
 {
   "ccsdsOmmVers": "1.0",
@@ -119,14 +141,17 @@ Response:
 }
 ```
 
-_For more examples, please refer to the [Documentation](https://github.com/StartUpNationLabs/react-flight-tracker-satellite)_
+_For more examples, please refer to
+the [Documentation](https://github.com/StartUpNationLabs/react-flight-tracker-satellite)_
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- API ENDPOINTS -->
+
 ## API Endpoints
 
 ### Get Satellite Detail
+
 * **URL**: `/v1/satellite/detail/{id}`
 * **Method**: `GET`
 * **Path Parameters**:
@@ -136,13 +161,15 @@ _For more examples, please refer to the [Documentation](https://github.com/Start
     * **Content**: `v1SatelliteDetail`
 
 ### Get Satellite Groups
+
 * **URL**: `/v1/satellite/groups`
 * **Method**: `GET`
 * **Success Response**:
     * **Code**: 200
     * **Content**: `v1GetSatelliteGroupsResponse`
 
 ### Get Minimal Satellites
+
 * **URL**: `/v1/satellite/minimal`
 * **Method**: `GET`
 * **Query Parameters**:
@@ -153,6 +180,7 @@ _For more examples, please refer to the [Documentation](https://github.com/Start
     * **Content**: `v1GetMinimalSatellitesResponse`
 
 ### Get Satellite Positions
+
 * **URL**: `/v1/satellite/positions`
 * **Method**: `GET`
 * **Query Parameters**:
@@ -165,6 +193,7 @@ _For more examples, please refer to the [Documentation](https://github.com/Start
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- ROADMAP -->
+
 ## Roadmap
 
 - [ ] Implement Satellite Path Calculation
@@ -173,16 +202,20 @@ _For more examples, please refer to the [Documentation](https://github.com/Start
 - [ ] Improve error handling
 - [ ] Enhance documentation
 
-See the [open issues](https://github.com/StartUpNationLabs/react-flight-tracker-satellite/issues) for a full list of proposed features (and known issues).
+See the [open issues](https://github.com/StartUpNationLabs/react-flight-tracker-satellite/issues) for a full list of
+proposed features (and known issues).
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- CONTRIBUTING -->
+
 ## Contributing
 
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any
+contributions you make are **greatly appreciated**.
 
-If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
+If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also
+simply open an issue with the tag "enhancement".
 Don't forget to give the project a star! Thanks again!
 
 1. Fork the Project
@@ -194,23 +227,27 @@ Don't forget to give the project a star! Thanks again!
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- LICENSE -->
+
 ## License
 
 Distributed under the MIT License. See `LICENSE.txt` for more information.
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- CONTACT -->
+
 ## Contact
 
-Apoorva Srinivas Appadoo - [LinkedIn][linkedin-url]
-Axel Delille - [LinkedIn](https://www.linkedin.com/in/axel-delille/)
+* Apoorva Srinivas Appadoo - [LinkedIn][linkedin-url]
+* Axel Delille - [LinkedIn](https://www.linkedin.com/in/axel-delille/)
 
-Project Link: [https://github.com/StartUpNationLabs/react-flight-tracker-satellite](https://github.com/StartUpNationLabs/react-flight-tracker-satellite)
+Project
+Link: [https://github.com/StartUpNationLabs/react-flight-tracker-satellite](https://github.com/StartUpNationLabs/react-flight-tracker-satellite)
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- ACKNOWLEDGMENTS -->
+
 ## Acknowledgments
 
 * [Space-Track](https://www.space-track.org/) for providing satellite data.
@@ -219,16 +256,29 @@ Project Link: [https://github.com/StartUpNationLabs/react-flight-tracker-satelli
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 <!-- MARKDOWN LINKS & IMAGES -->
+
 [contributors-shield]: https://img.shields.io/github/contributors/StartUpNationLabs/react-flight-tracker-satellite.svg?style=for-the-badge
+
 [contributors-url]: https://github.com/StartUpNationLabs/react-flight-tracker-satellite/graphs/contributors
+
 [forks-shield]: https://img.shields.io/github/forks/StartUpNationLabs/react-flight-tracker-satellite.svg?style=for-the-badge
+
 [forks-shield]: https://img.shields.io/github/forks/StartUpNationLabs/react-flight-tracker-satellite.svg?style=for-the-badge
+
 [forks-url]: https://github.com/StartUpNationLabs/react-flight-tracker-satellite/network/members
+
 [stars-shield]: https://img.shields.io/github/stars/StartUpNationLabs/react-flight-tracker-satellite?style=for-the-badge
+
 [stars-url]: https://github.com/StartUpNationLabs/react-flight-tracker-satellite/stargazers
+
 [issues-shield]: https://img.shields.io/github/issues/StartUpNationLabs/react-flight-tracker-satellite.svg?style=for-the-badge
+
 [issues-url]: https://github.com/StartUpNationLabs/react-flight-tracker-satellite/issues
+
 [license-shield]: https://img.shields.io/github/license/StartUpNationLabs/react-flight-tracker-satellite.svg?style=for-the-badge
+
 [license-url]: https://github.com/StartUpNationLabs/react-flight-tracker-satellite/blob/master/LICENSE.txt
+
 [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
+
 [linkedin-url]: https://www.linkedin.com/in/appadoo-apoorva-srinivas-481367207