Skip to content

Update README.md #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
hemtjanst-bot wants to merge 1 commit into from
Closed

Update README.md #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 1 addition & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1 @@
# Pana

A Go library for building on the Fediverse.

Pana provides everything you need to process and create [ActivityStreams][as] messages. These are the kinds of messages that are exchanged between clients and servers on the Fediverse.

[as]: https://www.w3.org/TR/activitystreams-core/

The API Pana provides is tailored towards social media style applications. The underlying library, [longdistance][ld], can be used for anything that use JSON-LD.

[ld]: https://codeberg.org/daenney/longdistance

## Usage

The [Go documentation][godoc] includes a [few examples][godocex].

[godoc]: https://pkg.go.dev/code.dny.dev/pana
[godocex]: https://pkg.go.dev/code.dny.dev/pana#example-package

## Contributing

PRs are very welcome for:
* Completing current ActivityStreams types.
* Fixes to existing types.
* Adding new object types that are in use on the Fediverse.
* Documentation improvements.

If you run into a bug, feel free to open up an issue.

## License

This library is licensed under the Mozilla Public License Version 2.0.
Testing