update docs
This commit is contained in:
parent
e7dc0a4248
commit
30b06876e0
|
@ -2,3 +2,22 @@ Welcome to ActivityPub Utilities's documentation!
|
|||
=================================================
|
||||
|
||||
ApUtils is a collection of classes and functions to aid in the development of an ActivityPub server.
|
||||
|
||||
|
||||
Installation
|
||||
~~~~~~~~~~~~
|
||||
|
||||
The only current installation source at the moment is git. Either install straight from the git url
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
python3 -m pip install git+https://git.barkshark.xyz/barkshark/aputils.git@0.1.0
|
||||
|
||||
or clone the repo and install locally
|
||||
|
||||
.. code-block:: bash
|
||||
|
||||
git clone https://git.barkshark.xyz/barkshark/aputils.git
|
||||
cd aputils
|
||||
git checkout 0.1.0
|
||||
python3 -m pip install .
|
||||
|
|
|
@ -1,2 +1,19 @@
|
|||
Usage
|
||||
=====
|
||||
|
||||
Each class and function in the API section can either be imported or accessed straight from the
|
||||
module. The following two code blocks do the same thing.
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
import aputils
|
||||
from pathlib import Path
|
||||
|
||||
signer = aputils.Signer(Path('privkey.pem'), 'https://social.example.com/users/cheese_wedge#main-key')
|
||||
|
||||
.. code-block:: python
|
||||
|
||||
from aputils import Signer
|
||||
from pathlib import Path
|
||||
|
||||
signer = Signer(Path('privkey.pem'), 'https://social.example.com/users/cheese_wedge#main-key')
|
||||
|
|
Loading…
Reference in a new issue