Add typedoc

[rbdr/forum] / README.md

diff --git a/README.md b/README.md
index e8b6201152eb7b3c0ce676e8a7f4a09d6fae0bf4..3e0f099872da2f0944ac77c52756fb317dfd1bea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -20,10 +20,11 @@ You can run tests with `npm test`. The tests use `testing-library`, `pact`,
 and `jest`.
 
 Here's some short guidelines:
-  - Every component that receives props or changes state should be tested.
-  - Test expected outcomes, not implementation details.
-  - Avoid mocking unless it's an external call
-  - Stores that interact with the API should be tested using pact
+
+- Every component that receives props or changes state should be tested.
+- Test expected outcomes, not implementation details.
+- Avoid mocking unless it's an external call
+- Stores that interact with the API should be tested using pact
 
 [node]: https://nodejs.org/en/
 [forum-server]: https://gitlab.com/rbdr/forum-server