From 59ddb4a093fd3ea10ef0e5304de32be87f9770ad Mon Sep 17 00:00:00 2001 From: Luciano Mammino Date: Thu, 21 Mar 2024 17:14:26 +0100 Subject: [PATCH] chore: README --- README.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) diff --git a/README.md b/README.md index e69de29..1626877 100644 --- a/README.md +++ b/README.md @@ -0,0 +1,48 @@ +# fullstack books + +[![main](https://github.com/FullStackBulletin/fullstack-books/actions/workflows/test.yaml/badge.svg)](https://github.com/FullStackBulletin/fullstack-books/actions/workflows/test.yaml) +![ts](https://badgen.net/badge/Built%20With/TypeScript/blue) + + +A static API to discover inspiring books for ambitious full-stack developers + + + +## Usage + +The base URL of the API is `https://fullStackbulletin.github.io/fullstack-books`. + +API Documentation is available as OpenAPI specification: + + - [OpenAPI definition (YAML)](https://fullStackbulletin.github.io/fullstack-books/openapi.yml) + - [OpenAPI definition (JSON)](https://fullStackbulletin.github.io/fullstack-books/openapi.json) + +[![Open API V3](https://img.shields.io/badge/open--API-in--editor-brightgreen.svg?style=flat&label=open-api-v3)](https://editor-next.swagger.io/?url=https%3A%2F%2FfullStackbulletin.github.io%2Ffullstack-books%2Fopenapi.yml) + + + + + +## Suggest a book + +TODO: + +If you want to suggest a new tech quote here's how you can do that. + +- [Fork this repository](https://github.com/FullStackBulletin/tech-quotes/fork) +- Edit the file [`src/quotes.ts`](/src/quotes.ts) and append the new fact at the bottom (make sure to follow the spec provided by the specific TypeScript types). +- Run `npm run test && npm run build` +- If all looks good, commit your changes +- Open a PR against the original repository + + +## Contributing + +Everyone is very welcome to contribute to this project. +You can contribute just by submitting bugs or suggesting improvements by +[opening an issue on GitHub](https://github.com/FullStackBulletin/fullstack-books/issues). + + +## License + +Licensed under [MIT License](LICENSE). © Luciano Mammino.