Skip to content

Commit 2875407

Browse files
committed
Merge #2: doc: update basic readme
f0d48b3 doc: update basic readme (Cameron Garnham) Pull request description: ACKs for top commit: da2ce7: ACK f0d48b3 Tree-SHA512: 3ab033a5396c80de716e4266b8a846c4b17f8498c28e7bbf46f50742cc5d1eba1a210cb2a4f7cdd5317c78cca2697188a6f29e0f180cf747d6166ad5e4703c5d
2 parents 3ef8ae3 + f0d48b3 commit 2875407

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

README.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,10 @@
1-
A simple TypeScript/ES6 library that contains API calls used by the Torrust Index project.
1+
# Torrust Index Application Interface
2+
3+
A simple TypeScript/ES6 library that contains API calls used by the [Torrust Index](https://github.com/torrust/torrust-index) project.
4+
5+
* [Torrust Index Backend](https://github.com/torrust/torrust-index-backend) is our reference implementation of this interface.
6+
* [Torrust Index Frontend](https://github.com/torrust/torrust-index-frontend) is our reference web-application that consumes this interface.
7+
28

39
## Install
410

0 commit comments

Comments
 (0)