Add some more specific typespecs and docs

bonfire-networks / activity_pub

Modular ActivityPub library in Elixir

GNU Affero General Public License v3.0

84 stars 10 forks source link

Add some more specific typespecs and docs #5

Closed Cantido closed 8 months ago

Cantido commented 1 year ago

These docs are from my own experimentation with the library, I'm hoping they're correct.

I'd love to help document this library! If you have any requests, I'll be happy to add to this.

mayel commented 8 months ago

@Cantido My apologies, this slipped through the cracks! Thanks for the contribution, I'll resolve conflicts and merge :)

mayel commented 8 months ago

@Cantido Merged thanks, much appreciated! I'm curious if you've been able to develop something with it?

Cantido commented 8 months ago

I've started to, yeah! But it's in its very early stages, and most of my projects never leave that stage haha. I have barely integrated the federation code and it's not actually federating anything yet. https://github.com/Cantido/chuuni

mayel commented 8 months ago

Good luck with it! A lot of interop testing and improvements has been going into the library (now getting a score of 96.6% on the test suite from https://data.funfedi.dev/ :) and hope it proves useful to other projects too...