From 8bb04402d997822a648ada0bdae50db18a9e2c52 Mon Sep 17 00:00:00 2001 From: Michael Demetriou Date: Sat, 14 Sep 2019 11:43:02 +0300 Subject: [PATCH] Add readme --- readme.md | 11 +++++++++++ 1 file changed, 11 insertions(+) create mode 100644 readme.md diff --git a/readme.md b/readme.md new file mode 100644 index 0000000..4802c8c --- /dev/null +++ b/readme.md @@ -0,0 +1,11 @@ +# ActivityServe + +## A very light ActivityPub library in go + +This library was built to support the very little functions that [pherephone](https://github.com/writeas/pherephone) requires. It might never be feature-complete but it's a very good point to start your activityPub journey. Take a look at [activityserve-example] for a simple main file that uses **activityserve** to post a "Hello, world" message. + +For now it supports following and unfollowing users, accepting follows, announcing (boosting) other posts and this is pretty much it. + +The library is still a moving target and the api is not guaranteed to be stable. + +You can override the auto-accept upon follow by setting the `actor.OnFollow` to a custom function. \ No newline at end of file