Skip to content

Commit e44656e

Browse files
committed
Enhance README and metadata with author details, attribution, and project keywords
- Added author section with attribution and badges to `README.md`. - Updated license section with detailed attribution guidelines. - Expanded project description and added relevant keywords in `package.json` for improved discoverability.
1 parent f035cd1 commit e44656e

2 files changed

Lines changed: 34 additions & 4 deletions

File tree

README.md

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
[![Author](https://img.shields.io/badge/Author-Vadim%20Starichkov-blue?style=for-the-badge)](https://github.com/starichkov)
12
[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/starichkov/nodejs-simple-notes-app/node.js.yml?style=for-the-badge)](https://github.com/starichkov/nodejs-simple-notes-app/actions/workflows/node.js.yml)
23
[![Codecov](https://img.shields.io/codecov/c/github/starichkov/nodejs-simple-notes-app?style=for-the-badge)](https://codecov.io/gh/starichkov/nodejs-simple-notes-app)
34
[![GitHub License](https://img.shields.io/github/license/starichkov/nodejs-simple-notes-app?style=for-the-badge)](https://github.com/starichkov/nodejs-simple-notes-app/blob/main/LICENSE.md)
@@ -7,6 +8,12 @@ Notes API: Node.js with Express and NoSQL Databases
78

89
A RESTful API for managing text notes, built with Node.js, Express, and NoSQL databases. The application follows a database-agnostic architecture, allowing for easy switching between database vendors (currently supports CouchDB and MongoDB).
910

11+
## 👨‍💻 Author
12+
13+
**Vadim Starichkov** | [GitHub](https://github.com/starichkov) | [Email](mailto:starichkovva@gmail.com)
14+
15+
*Created as part of a modern Node.js development practices demonstration*
16+
1017
## Features
1118

1219
- Create, read, update, and delete text notes
@@ -332,6 +339,18 @@ if (DB_VENDOR === 'new-vendor') {
332339
}
333340
```
334341

335-
## License
342+
## 📄 License & Attribution
343+
344+
This project is licensed under the **MIT License** - see the [LICENSE](LICENSE.md) file for details.
345+
346+
### Using This Project?
347+
348+
If you use this code in your own projects, attribution is required under the MIT License:
349+
350+
```
351+
Based on nodejs-simple-notes-app by Vadim Starichkov, TemplateTasks
352+
353+
https://github.com/starichkov/nodejs-simple-notes-app
354+
```
336355

337-
See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).
356+
**Copyright © 2025 Vadim Starichkov, TemplateTasks**

package.json

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,21 @@
88
"test:coverage": "node --experimental-vm-modules node_modules/jest/bin/jest.js --coverage",
99
"start": "node src/notes-api-server.js"
1010
},
11-
"keywords": [],
11+
"keywords": [
12+
"nodejs",
13+
"express",
14+
"notes-api",
15+
"restful-api",
16+
"couchdb",
17+
"mongodb",
18+
"nosql",
19+
"database-agnostic",
20+
"crud-api",
21+
"web-ui"
22+
],
1223
"author": "Vadim Starichkov <starichkovva@gmail.com>",
1324
"license": "MIT",
14-
"description": "Example of Node.js simple HTTP server",
25+
"description": "RESTful Notes API with Node.js, Express, and NoSQL databases (CouchDB/MongoDB) - database-agnostic architecture with web UI",
1526
"repository": {
1627
"type": "git",
1728
"url": "https://github.com/starichkov/nodejs-simple-notes-app.git"

0 commit comments

Comments
 (0)