Merge pull request #14 from sarvsav/update-readme

Update readme

.gitignore

@@ -52,3 +52,7 @@ gen/**
 
 # Ignore deps.bzl as it is generated by gazelle
 deps.bzl
+
+# Ignore node module & .docusaurus inside docs directory for docusaurus
+docs/node_modules
+docs/.docusaurus

README.md

@@ -23,7 +23,6 @@
 [![Stargazers][stars-shield]][stars-url]
 [![Issues][issues-shield]][issues-url]
 [![MIT License][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
 
 
 
@@ -39,14 +38,14 @@
   <p align="center">
     A boiler plate for your Go project with best practices
     <br />
-    <a href="https://github.com/sarvsav/go-starter-template"><strong>Explore the docs »</strong></a>
+    <a href="https://sarvsav.github.io/go-starter-template/"><strong>📘 Explore the docs  »</strong></a>
     <br />
     <br />
-    <a href="https://github.com/sarvsav/go-starter-template">View Demo</a>
+    <a href="https://calendly.com/sarvsav">📅 Book a meeting</a>
     ·
-    <a href="https://github.com/sarvsav/go-starter-template/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
+    <a href="https://github.com/sarvsav/go-starter-template/issues/new?assignees=sarvsav&labels=bug%2Cneeds-triage&projects=&template=01_bug_report.yml">🐛 Report Bug</a>
     ·
-    <a href="https://github.com/sarvsav/go-starter-template/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
+    <a href="https://github.com/sarvsav/go-starter-template/issues/new?assignees=sarvsav&labels=enhancement%2Cneeds-triage&projects=&template=02_feature_request.yml"> 🔨 Request Feature</a>
   </p>
 </div>
 
@@ -74,6 +73,7 @@
     <li><a href="#contributing">Contributing</a></li>
     <li><a href="#license">License</a></li>
     <li><a href="#contact">Contact</a></li>
+    <li><a href="#contributors">Contributors</a></li>
     <li><a href="#acknowledgments">Acknowledgments</a></li>
   </ol>
 </details>
@@ -83,24 +83,19 @@
 <!-- ABOUT THE PROJECT -->
 ## About The Project
 
-[![Product Name Screen Shot][product-screenshot]](https://example.com)
+[![Go Starter Template][product-screenshot]](https://sarvsav.github.io/go-starter-template/)
 
-Here's a blank template to get started: To avoid retyping too much info. Do a search and replace with your text editor for the following: `github_username`, `repo_name`, `twitter_handle`, `linkedin_username`, `email_client`, `email`, `project_title`, `project_description`
+This is a starter template for your `go` based projects. It is supercharged with latest technologies like `bazel`, `grpc`, `linters`, and much more. The new updates related to features, bug fixes, and securities will keep on adding with newer version of the template. The detailed version can be found on [project website](https://sarvsav.github.io/go-starter-template/).
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
 
 
 ### Built With
 
-* [![Next][Next.js]][Next-url]
-* [![React][React.js]][React-url]
-* [![Vue][Vue.js]][Vue-url]
-* [![Angular][Angular.io]][Angular-url]
-* [![Svelte][Svelte.dev]][Svelte-url]
-* [![Laravel][Laravel.com]][Laravel-url]
-* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
-* [![JQuery][JQuery.com]][JQuery-url]
+[![Go][Golang]][Go-url]
+<br>
+[![Bazel][Bazel]][Bazel-url]
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
@@ -216,6 +211,15 @@ Kindly refer to the [contributing guide](./CONTRIBUTING.md) to contribute to the
 
 <p align="right">(<a href="#readme-top">back to top</a>)</p>
 
+<!-- ADOPTERS -->
+## Adopters
+
+📢 If you're using go-starter-template in your organization, please add your company name to this list.
+
+By adding yourself to the [ADOPTERS.md](./ADOPTERS.md) file, you help increase the project's visibility and credibility, which is essential for its growth.
+
+<p align="right">(<a href="#readme-top">back to top</a>)</p>
+
 <!-- ACKNOWLEDGMENTS -->
 ## Acknowledgments
 
@@ -241,20 +245,8 @@ Kindly refer to the [contributing guide](./CONTRIBUTING.md) to contribute to the
 [license-url]: https://github.com/sarvsav/go-starter-template/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://linkedin.com/in/linkedin_username
-[product-screenshot]: images/screenshot.png
-[Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge&logo=nextdotjs&logoColor=white
-[Next-url]: https://nextjs.org/
-[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
-[React-url]: https://reactjs.org/
-[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
-[Vue-url]: https://vuejs.org/
-[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
-[Angular-url]: https://angular.io/
-[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
-[Svelte-url]: https://svelte.dev/
-[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
-[Laravel-url]: https://laravel.com
-[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
-[Bootstrap-url]: https://getbootstrap.com
-[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
-[JQuery-url]: https://jquery.com 
+[product-screenshot]: assets/go-starter-template.png
+[Golang]: https://img.shields.io/github/go-mod/go-version/sarvsav/go-starter-template?style=for-the-badge&logo=go
+[Go-url]: https://go.dev/
+[Bazel]: https://img.shields.io/badge/Bazel-v7-brightgreen?style=for-the-badge&logo=bazel
+[Bazel-url]: https://bazel.build/