Version control and retrieval endpoints

README.md

@@ -17,3 +17,69 @@ Start project:
 ```sh
 npm run start
 ```
+
+## Usage
+
+You can use Postman or Curl to make calls to the API. The examples below use Curl.
+
+### Create a topic:
+
+```sh
+curl -X POST http://localhost:3000/api/topics \
+  -H "Content-Type: application/json" \
+  -d '{"name": "A topic", "content": "Topic content"}'
+```
+
+### Get all topics:
+
+```sh
+curl -X GET http://localhost:3000/api/topics
+```
+
+### Get specific topic:
+
+```sh
+curl -X GET http://localhost:3000/api/topics/1234567890
+```
+
+> Replace `1234567890` with the topic id.
+
+### Update a topic:
+
+```sh
+curl -X PUT http://localhost:3000/api/topics/1234567890 \
+  -H "Content-Type: application/json" \
+  -d '{"name": "Updated topic"}'
+```
+
+> Replace `1234567890` with the topic id.
+
+### Get specific version of a topic:
+
+```sh
+curl -X GET http://localhost:3000/api/topics/1234567890/1
+```
+
+### Create a child topic:
+
+```sh
+curl -X POST http://localhost:3000/api/topics \
+  -H "Content-Type: application/json" \
+  -d '{"name": "A topic", "content": "Topic content", "parentTopicId": 1234567890 }'
+```
+
+### Delete a topic:
+
+```sh
+curl -X DELETE http://localhost:3000/api/topics/1234567890
+```
+
+> Replace `1234567890` with the topic id.
+
+## Tests
+
+Run tests with:
+
+```sh
+npm run test
+```