Skip to content

Commit

Permalink
docs: update docs to include badges, authors and license
Browse files Browse the repository at this point in the history
  • Loading branch information
sydrawat01 committed Jan 12, 2024
1 parent ec3fcb6 commit 0e08553
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# REST API

[![Release](https://github.com/sydrawat01/rest-api/actions/workflows/release.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/release.yml) [![Unit Tests](https://github.com/sydrawat01/rest-api/actions/workflows/unit-test.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/unit-test.yml) [![Packer AMI template validation](https://github.com/sydrawat01/rest-api/actions/workflows/packer-validate.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/packer-validate.yml)
[![Unit Tests](https://github.com/sydrawat01/rest-api/actions/workflows/unit-test.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/unit-test.yml) [![Packer AMI template validation](https://github.com/sydrawat01/rest-api/actions/workflows/packer-validate.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/packer-validate.yml) [![Build](https://github.com/sydrawat01/rest-api/actions/workflows/packer-build.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/packer-build.yml) [![Release](https://github.com/sydrawat01/rest-api/actions/workflows/release.yml/badge.svg)](https://github.com/sydrawat01/rest-api/actions/workflows/release.yml)

This is a basic skeleton code to create a basic REST API using NodeJS, ExpressJS and Babel.

Expand Down Expand Up @@ -310,3 +310,11 @@ docker image rm api:v2
### Work in progress
Do not build `.env` into the docker image.
## Author
[Siddharth Rawat](mailto:sydrawat@gmail.com)
## License
[MIT License](./LICENSE)

0 comments on commit 0e08553

Please sign in to comment.