indymedia
/
epicyon
mirror of https://gitlab.com/bashrc2/epicyon
7
4
Fork 1
Code Issues 14 Releases Wiki Activity

Indents

merge-requests/3/head
Bob Mottram 2019-11-11 21:31:16 +00:00
parent 0f2c4ff212
commit e78f453460
1 changed files with 18 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
README_commandline.md
View File

@ -87,8 +87,8 @@ To make a public post:
``` bash ``` bash
python3 epicyon.py --nickname [yournick] --domain [name] \ python3 epicyon.py --nickname [yournick] --domain [name] \
--sendto public --message "hello" \ --sendto public --message "hello" \
--warning "This is a content warning" \ --warning "This is a content warning" \
--password [c2s password] --password [c2s password]
``` ```
To post to followers only: To post to followers only:
@ -96,8 +96,8 @@ To post to followers only:
``` bash ``` bash
python3 epicyon.py --nickname [yournick] --domain [name] \ python3 epicyon.py --nickname [yournick] --domain [name] \
--sendto followers --message "hello" \ --sendto followers --message "hello" \
--warning "This is a content warning" \ --warning "This is a content warning" \
--password [c2s password] --password [c2s password]
``` ```
To send a post to a particular address (direct message): To send a post to a particular address (direct message):
@ -105,8 +105,8 @@ To send a post to a particular address (direct message):
``` bash ``` bash
python3 epicyon.py --nickname [yournick] --domain [name] \ python3 epicyon.py --nickname [yournick] --domain [name] \
--sendto othernick@domain --message "hello" \ --sendto othernick@domain --message "hello" \
--warning "This is a content warning" \ --warning "This is a content warning" \
--password [c2s password] --password [c2s password]
``` ```
The password is the c2s password for your account. The password is the c2s password for your account.
@ -116,10 +116,10 @@ You can also attach an image. It must be in png, jpg or gif format.
``` bash ``` bash
python3 epicyon.py --nickname [yournick] --domain [name] \ python3 epicyon.py --nickname [yournick] --domain [name] \
--sendto othernick@domain --message "bees!" \ --sendto othernick@domain --message "bees!" \
--warning "bee-related content" --attach bees.png \ --warning "bee-related content" --attach bees.png \
--imagedescription "bees on flowers" \ --imagedescription "bees on flowers" \
--blurhash \ --blurhash \
--password [c2s password] --password [c2s password]
``` ```
## Viewing Public Posts ## Viewing Public Posts
@ -273,8 +273,8 @@ Within an organization you may want to define different roles and for some proje
``` bash ``` bash
python3 epicyon.py --nickname [admin nickname] --domain [mydomain] \ python3 epicyon.py --nickname [admin nickname] --domain [mydomain] \
--delegate [person nickname] \ --delegate [person nickname] \
--project [project name] --role [title] \ --project [project name] --role [title] \
--password [c2s password] --password [c2s password]
``` ```
The other person could also be made a delegator, but they will only be able to delegate further within projects which they're assigned to. By design, this creates a restricted organizational hierarchy. For example: The other person could also be made a delegator, but they will only be able to delegate further within projects which they're assigned to. By design, this creates a restricted organizational hierarchy. For example:
@ -282,8 +282,8 @@ The other person could also be made a delegator, but they will only be able to d
``` bash ``` bash
python3 epicyon.py --nickname [admin nickname] --domain [mydomain] \ python3 epicyon.py --nickname [admin nickname] --domain [mydomain] \
--delegate [person nickname] \ --delegate [person nickname] \
--project [project name] --role delegator \ --project [project name] --role delegator \
--password [c2s password] --password [c2s password]
``` ```
A delegated role can also be removed. A delegated role can also be removed.
@ -291,8 +291,8 @@ A delegated role can also be removed.
``` bash ``` bash
python3 epicyon.py --nickname [admin nickname] --domain [mydomain] \ python3 epicyon.py --nickname [admin nickname] --domain [mydomain] \
--undelegate [person nickname] \ --undelegate [person nickname] \
--project [project name] \ --project [project name] \
--password [c2s password] --password [c2s password]
``` ```
This extends the ActivityPub client-to-server protocol to include activities called *Delegate* and *Role*. The json looks like: This extends the ActivityPub client-to-server protocol to include activities called *Delegate* and *Role*. The json looks like:
@ -320,7 +320,7 @@ To help create organizations you can assign some skills to your account. Note th
``` bash ``` bash
python3 epicyon.py --nickname [nick] --domain [mydomain] \ python3 epicyon.py --nickname [nick] --domain [mydomain] \
--skill [tag] --level [0-100] \ --skill [tag] --level [0-100] \
--password [c2s password] --password [c2s password]
``` ```
The level value is a percentage which indicates how proficient you are with that skill. The level value is a percentage which indicates how proficient you are with that skill.
@ -342,7 +342,7 @@ For the purpose of things like knowing current task status or task completion a
``` bash ``` bash
python3 epicyon.py --nickname [nick] --domain [mydomain] \ python3 epicyon.py --nickname [nick] --domain [mydomain] \
--availability [status] \ --availability [status] \
--password [c2s password] --password [c2s password]
``` ```
The status value can be any string, and can become part of organization building by combining it with roles and skills. The status value can be any string, and can become part of organization building by combining it with roles and skills.