diff --git a/README.md b/README.md index 0be785d..31c0119 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,41 @@ -Based on this [repository](https://github.com/EbookFoundation/free-programming-books/blob/master/free-programming-books.md) +# free-it-books + +## Table of Contents + +1. [Description](#Description) +1. [Links](#Link) +1. [Environment](#environment) +1. [Contributing](#contributing) +1. [Authors](#authors) + +## Description +Free-it-books is based on this [repository](https://github.com/EbookFoundation/free-programming-books/blob/master/free-programming-books.md) -UI Framework used: https://sap.github.io/fundamental/ +## Link [Demo website](https://unseen1980.github.io/free-it-books/) + + +## Project setup + +### Install dependencies +``` +yarn install +``` + +### Compiles and runs react scripts +``` +yarn start +``` + +## Built With + +UI Framework used: https://sap.github.io/fundamental/ +- [React](http://www.https://vuejs.org/) - Framework + +## Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. + +## Authors +[@unseen1980#6](https://github.com/ottotsuma/free-it-books/commits?author=unseen1980)