Skip to content
This repository was archived by the owner on Mar 23, 2023. It is now read-only.

Commit eba3b06

Browse files
Update README to include link to API specifications
1 parent cc0d20f commit eba3b06

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

README.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
[![Build Status](https://travis-ci.org/mena-devs/tilde.svg?branch=master)](https://travis-ci.org/mena-devs/tilde)
22

33
[![Maintainability](https://api.codeclimate.com/v1/badges/618cfe32cf0874f94648/maintainability)](https://codeclimate.com/github/mena-devs/tilde/maintainability)
4+
45
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmena-devs%2Ftilde.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmena-devs%2Ftilde?ref=badge_shield)
56

67
[![Test Coverage](https://api.codeclimate.com/v1/badges/618cfe32cf0874f94648/test_coverage)](https://codeclimate.com/github/mena-devs/tilde/test_coverage)
@@ -19,7 +20,9 @@ If you have a feature request, please open a ticket.
1920

2021
This README describes the purpose of this repository and how to set up a development environment. Other sources of documentation are as follows:
2122

22-
* UI and API designs are in `doc/`
23+
* UI and API designs are in `docs/`
24+
25+
API specifications are [located here](https://mena-devs.github.io/tilde/api_specifications/index.html)
2326

2427
## Purpose and features
2528

@@ -67,6 +70,5 @@ To test sent out emails during development, navigate to `localhost:3000/letter_o
6770

6871
For contributions, please follow the following [git workflow](GIT-WORKFLOW.md)
6972

70-
7173
## License
7274
[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Fmena-devs%2Ftilde.svg?type=large)](https://app.fossa.io/projects/git%2Bgithub.com%2Fmena-devs%2Ftilde?ref=badge_large)

0 commit comments

Comments
 (0)