versia-pub/api
2
0
Fork 0
mirror of https://github.com/versia-pub/api.git synced 2025-12-06 08:28:19 +01:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(federation): 🐛 Update docs to match API changes

Browse source
This commit is contained in:
Jesse Wierzbinski 2024-06-25 19:19:38 -10:00
parent 9c4bc08e2f
commit 0c7e59849a
No known key found for this signature in database
2 changed files with 3 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
README.md
View file

@ -25,11 +25,6 @@ Please see the [**`@lysand-org/federation` README**](federation/README.md) for m
### Client
#### Roadmap
- [x] Parity with [**megalodon**](https://github.com/h3poteto/megalodon)'s Mastodon client
- [ ] Lysand-specific features
Please see the [**`@lysand-org/client` README**](client/README.md) for more information.
## Getting Started

4
federation/README.md
View file

@ -38,7 +38,9 @@ try {
}
// Types are also included for TypeScript users that don't use the extracted ones
const validNoteObject: typeof EntityValidator.$Note = {
import type { Note } from "@lysand-org/federation/types";
const validNoteObject: Note = {
type: "Note",
// ...
};