Skip to content

Commit

Permalink
Some docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dahlia committed Mar 4, 2024
1 parent b264f15 commit 8c72cd9
Show file tree
Hide file tree
Showing 8 changed files with 224 additions and 90 deletions.
2 changes: 2 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@
"docloader",
"fedify",
"fediverse",
"httpsig",
"jsonld",
"langstr",
"Lemmy",
Expand All @@ -42,6 +43,7 @@
"rels",
"subproperty",
"superproperty",
"unfollow",
"webfinger"
]
}
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@
Fedify: a fediverse server framework
====================================

[![JSR][JSR badge]][JSR]
[![GitHub Actions][GitHub Actions badge]][GitHub Actions]

Fedify is a [Deno]/TypeScript library for building federated server apps
powered by [ActivityPub] and other standards, which is so-called [fediverse].
You may already know some of the networks in the fediverse, such as [Mastodon],
Expand All @@ -27,6 +30,10 @@ The rough roadmap is to implement the following features out of the box:
Currently this project is not well documented, but you can find some examples
in the *examples/* directory.

[JSR]: https://jsr.io/@fedify/fedify
[JSR badge]: https://jsr-badge.deno.dev/@fedify/fedify/unstable.svg
[GitHub Actions]: https://github.com/dahlia/fedify/actions/workflows/build.yaml
[GitHub Actions badge]: https://github.com/dahlia/fedify/actions/workflows/build.yaml/badge.svg
[Deno]: https://deno.com/
[ActivityPub]: https://www.w3.org/TR/activitypub/
[fediverse]: https://en.wikipedia.org/wiki/Fediverse
Expand Down
Loading

0 comments on commit 8c72cd9

Please sign in to comment.