Skip to content
This repository was archived by the owner on Sep 12, 2025. It is now read-only.

Commit 7c5c718

Browse files
authored
Merge pull request #138 from octoquad/137-update-documentation-info
2 parents 3100221 + de65bc8 commit 7c5c718

File tree

1 file changed

+13
-1
lines changed

1 file changed

+13
-1
lines changed

README.md

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,19 @@ events.on('message', message => {
4545
});
4646
```
4747

48-
For more details see the [full API documentation](http://chadmcelligott.com/awry).
48+
### documentation
49+
50+
Documentation is available in the repository. You can compile the documentation
51+
by doing the following:
52+
53+
```shell
54+
git clone git@github.com:chadxz/awry.git
55+
cd awry
56+
npm install
57+
npm run docs
58+
```
59+
60+
The latest documentation can now be found under the `docs` directory.
4961

5062
### debugging
5163

0 commit comments

Comments
 (0)