-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
6 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,8 @@ | ||
# polyproto | ||
Specification documents and API documentation for the polyproto federated messaging protocol | ||
|
||
## File structure | ||
|
||
The `/docs` folder contains the specification documents for the polyproto protocol. The `docs/APIs` folder contains the API documentation for the polyproto-core and polyphony-chat reference implementation. | ||
|
||
The `/snippets` folder contains snippets of text that are used in multiple places in the documentation. This is to ensure consistency across the documentation. Any error messages that are used in multiple places are also stored here, in the `/snippets/errors` folder. |