diff --git a/README.md b/README.md index a149479d46a8b2b995da819fdab0d24ac3adf07d..b3e3c36e23b81d36010bc62b420a190ea11be368 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,50 @@ - - +# [](https://gitlab.c3sl.ufpr.br/c3sl/blendb) [](https://gitlab.c3sl.ufpr.br/c3sl/blendb/commits/master) +[](https://gitlab.c3sl.ufpr.br/c3sl/blendb/builds) + +<p align="center"> +<b><a href="#getting-started">Getting Started</a></b> +| +<b><a href="#api-reference">API Reference</a></b> +| +<b><a href="#contributing">Contributing</a></b> +| +<b><a href="#license">License</a></b> +| +<b><a href="#built-with">Built With</a></b> +</p> + +<br/> + +## Getting Started + +### Installing + +``` +git clone https://gitlab.c3sl.ufpr.br/c3sl/blendb.git +npm install +``` + +### Running + +``` +npm start +``` + +## API Reference + +Check the documentation [here](https://gitlab.c3sl.ufpr.br/c3sl/blendb/raw/master/doc/api-v1-reference.html). + +## Contributing + +Please read [CONTRIBUTING.md](CONTRIBUTING.md) for details on our code of conduct, and the process for submitting merge requests to us. + +## License + +This project is licensed under the GPLv3 License -- see the [LICENSE](LICENSE) file for details + +## Built With + +| [](https://expressjs.com) | [](https://www.typescriptlang.org/) | [](http://raml.org/) | +|:---:|:---:|:---:| +|express|TypeScript|RAML| diff --git a/artwork/built-with/express.png b/artwork/built-with/express.png new file mode 100644 index 0000000000000000000000000000000000000000..6edf486dd923a75d7f2d8f52e92b65f6e21c4554 Binary files /dev/null and b/artwork/built-with/express.png differ diff --git a/artwork/built-with/raml.png b/artwork/built-with/raml.png new file mode 100644 index 0000000000000000000000000000000000000000..ecba4e5d67f0868e19f7f2dba5fd041b22e4bc7d Binary files /dev/null and b/artwork/built-with/raml.png differ diff --git a/artwork/built-with/typescript.png b/artwork/built-with/typescript.png new file mode 100644 index 0000000000000000000000000000000000000000..eaa81ed44fb07634228de20f57f230916a163ee3 Binary files /dev/null and b/artwork/built-with/typescript.png differ