kjuulh/octopush
1
0
Fork 0
Code Issues 1 Pull Requests 2 Packages Projects Releases Wiki Activity

Add a basic readme

Browse Source
This commit is contained in:
Kasper Juul Hermansen 2022-09-18 17:04:54 +02:00
parent d6d98c2ce8
commit 021ddc212f
Signed by: kjuulh
GPG Key ID: 57B6E1465221F912
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -34,10 +34,10 @@ Refer to [roadmap.md](roadmap.md)
## Installation ## Installation
Octopush comes in two modes. Client or Client -> Server. Octopush can stand alone as Octopush comes in two modes. Client or Client -> Server. Octopush can stand
a client, for smaller and less secure changes. However, for organisations, it alone as a client, for smaller and less secure changes. However, for
may be useful to use Octopush in server mode, which supports more features, and organisations, it may be useful to use Octopush in server mode, which supports
has extra security built in. more features, and has extra security built in.
### Client (CLI) ### Client (CLI)
@ -182,8 +182,8 @@ To run the script use
octopush process --path "write-a-readme" octopush process --path "write-a-readme"
``` ```
This will cause the octopush process to automatically apply the action on the repo This will cause the octopush process to automatically apply the action on the
and open a pr. repo and open a pr.
### Query repositories ### Query repositories
@ -212,8 +212,8 @@ to help test locally, as well as not cause serious issues. The server
configuration is pretty much the same, except the command would look like so: configuration is pretty much the same, except the command would look like so:
`octopush server process --path "write-a-readme" --apply`. Octopush will try to `octopush server process --path "write-a-readme" --apply`. Octopush will try to
infer as much as possible, but it may be needed to apply some extra flags to infer as much as possible, but it may be needed to apply some extra flags to
specify upstream repositories and such. Octopush will also help you setup keys and specify upstream repositories and such. Octopush will also help you setup keys
such on the first run, using `octopush setup` or `octopush server setup`. and such on the first run, using `octopush setup` or `octopush server setup`.
## Contributing ## Contributing