Skip to content

Commit 59ddb4a

Browse files
committed
chore: README
1 parent 8245984 commit 59ddb4a

File tree

1 file changed

+48
-0
lines changed

1 file changed

+48
-0
lines changed

README.md

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
# fullstack books
2+
3+
[![main](https://github.com/FullStackBulletin/fullstack-books/actions/workflows/test.yaml/badge.svg)](https://github.com/FullStackBulletin/fullstack-books/actions/workflows/test.yaml)
4+
![ts](https://badgen.net/badge/Built%20With/TypeScript/blue)
5+
6+
7+
A static API to discover inspiring books for ambitious full-stack developers
8+
9+
10+
11+
## Usage
12+
13+
The base URL of the API is `https://fullStackbulletin.github.io/fullstack-books`.
14+
15+
API Documentation is available as OpenAPI specification:
16+
17+
- [OpenAPI definition (YAML)](https://fullStackbulletin.github.io/fullstack-books/openapi.yml)
18+
- [OpenAPI definition (JSON)](https://fullStackbulletin.github.io/fullstack-books/openapi.json)
19+
20+
[![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)
21+
22+
<!-- openapi -->
23+
<!-- openapi -->
24+
25+
26+
## Suggest a book
27+
28+
TODO:
29+
30+
If you want to suggest a new tech quote here's how you can do that.
31+
32+
- [Fork this repository](https://github.com/FullStackBulletin/tech-quotes/fork)
33+
- 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).
34+
- Run `npm run test && npm run build`
35+
- If all looks good, commit your changes
36+
- Open a PR against the original repository
37+
38+
39+
## Contributing
40+
41+
Everyone is very welcome to contribute to this project.
42+
You can contribute just by submitting bugs or suggesting improvements by
43+
[opening an issue on GitHub](https://github.com/FullStackBulletin/fullstack-books/issues).
44+
45+
46+
## License
47+
48+
Licensed under [MIT License](LICENSE). © Luciano Mammino.

0 commit comments

Comments
 (0)