Skip to content

Commit f48469d

Browse files
committed
Update README.md with badges, author section, and license details
Enhanced documentation by adding shields.io badges, author attribution, and licensing section. Expanded project description and usage guidance.
1 parent 9265089 commit f48469d

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,21 @@
1-
# Notes Management API
2-
1+
[![Author](https://img.shields.io/badge/Author-Vadim%20Starichkov-blue?style=for-the-badge)](https://github.com/starichkov)
32
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/starichkov/golang-simple-notes/build.yml?style=for-the-badge)](https://github.com/starichkov/golang-simple-notes/actions/workflows/build.yml)
43
[![Codecov](https://img.shields.io/codecov/c/github/starichkov/golang-simple-notes?style=for-the-badge)](https://codecov.io/gh/starichkov/golang-simple-notes)
54
[![GitHub License](https://img.shields.io/github/license/starichkov/golang-simple-notes?style=for-the-badge)](https://github.com/starichkov/golang-simple-notes/blob/main/LICENSE.md)
65

6+
Notes API: Golang with NoSQL Databases
7+
=
8+
79
A simple microservice for notes management with REST and gRPC APIs, with support for multiple storage backends.
810

911
**This project is generated using JetBrains Junie and several other AI coding agents, to evaluate agents capabilities.**
1012

13+
## 👨‍💻 Author
14+
15+
**Vadim Starichkov** | [GitHub](https://github.com/starichkov) | [Email](mailto:starichkovva@gmail.com)
16+
17+
*Developed to demonstrate modern Golang development practices and patterns*
18+
1119
## Features
1220

1321
- REST API for CRUD operations on notes
@@ -278,3 +286,19 @@ The application can be configured using environment variables:
278286
- `MONGODB_URI` - The URI of the MongoDB server (default: "mongodb://localhost:27017")
279287
- `MONGODB_DB` - The name of the MongoDB database (default: "notes")
280288
- `MONGODB_COLLECTION` - The name of the MongoDB collection (default: "notes")
289+
290+
## 📄 License & Attribution
291+
292+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE.md) file for details.
293+
294+
### Using This Project?
295+
296+
If you use this code in your own projects, attribution is required under the MIT License:
297+
298+
```
299+
Based on golang-simple-notes by Vadim Starichkov, TemplateTasks
300+
301+
https://github.com/starichkov/golang-simple-notes
302+
```
303+
304+
**Copyright © 2025 Vadim Starichkov, TemplateTasks**

0 commit comments

Comments
 (0)