Skip to content

Commit 3c3b543

Browse files
committed
add: more improved version
1 parent cb6f9e7 commit 3c3b543

File tree

1 file changed

+25
-7
lines changed

1 file changed

+25
-7
lines changed

README.md

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
**BootstrapCLI** is a CLI tool that scaffolds production-ready Golang projects — no dependency headaches, no manual setup.
44
Just run a command and get a fully configured project with linters, routers, and structure ready to code.
55

6+
> Note: This is my first OSS project, I want to make a CLI tool(maybe webUI) which is not just generator tool which only generate go code, but it will help developers to follow best practices, and assist during the project development. In future versions of the project i will add AI which will help developer to assist during their development and help in debugging + fixing error. I am adding AI not to generate code in there project but for assisting purpose only.
7+
68
* * *
79
## Installation
810

@@ -107,9 +109,6 @@ Create a new project using yaml file configurations
107109
**BootstrapCLI** automates all that.
108110
You focus on business logic — it handles the rest.
109111

110-
> Note: This is my first OSS project, I want to make a CLI tool(maybe webUI) which is not just generator tool which only generate
111-
> go code, but it will help developers to follow best practices, and assist during the project development. In future versions of the project i will add AI which will help developer to assist during their development and help in debugging + fixing error. I am adding AI not to generate code in there project but for assisting purpose only.
112-
113112
* * *
114113

115114
## Roadmap
@@ -123,15 +122,34 @@ You focus on business logic — it handles the rest.
123122

124123
## Contributing
125124

126-
Contributions, feedback, and ideas are welcome!
127-
Feel free to open an issue or PR on [GitHub](https://github.com/upsaurav12/bootstrap).
125+
Contributions, feedback, and ideas are welcome.
126+
127+
If you would like to contribute:
128+
129+
- Open an issue to report bugs or suggest features
130+
131+
- Submit a pull request with clear context and rationale
132+
133+
Please ensure that:
128134

129-
Hope you like this project.
135+
- Code changes are well-structured and documented
136+
137+
- New features include appropriate tests where applicable
138+
139+
- Existing functionality is not broken
140+
141+
You can get started by visiting the project repository on GitHub:
142+
https://github.com/upsaurav12/bootstrap
143+
144+
If you find this project useful, consider giving it a star ⭐ — it helps with visibility and continued development.
130145

131146
* * *
132147

133148
## License
134149

135-
Licensed under the **MIT License** © 2026 [Saurav Upadhyay](https://github.com/upsaurav12)
150+
This project is licensed under the MIT License.
151+
152+
© 2026 [Saurav Upadhyay](https://github.com/upsaurav12)
136153

154+
See the LICENSE file for full license details.
137155
* * *

0 commit comments

Comments
 (0)