theluyuan/shynet
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve README consistency

Browse Source
This commit is contained in:
R. Miles McCain 2020-04-24 16:28:28 -04:00
parent 2e386a7e25
commit 3a63f6f850
No known key found for this signature in database
GPG Key ID: 24F9B6A2588C5408
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -40,10 +40,10 @@ Not shown: service view, management view, session view, full service view. (You'
#### Architecture #### Architecture
* **Runs on a single machine** — Because it's so small, Shynet can easily run as a single docker container on a single small VPS. * **Runs on a single machine** — Because it's so small, Shynet can easily run as a single docker container on a single small VPS
* **...or across a giant Kubernetes cluster** — For higher traffic installations, Shynet can be deployed with as many parallelized ingress nodes as needed, with Redis caching and separate backend workers for database IO. * **...or across a giant Kubernetes cluster** — For higher traffic installations, Shynet can be deployed with as many parallelized ingress nodes as needed, with Redis caching and separate backend workers for database IO
* **Built using Django** — Shynet is built using Django, so deploying, updating, and migrating can be done without headaches. * **Built using Django** — Shynet is built using Django, so deploying, updating, and migrating can be done without headaches
* **Multiple users and sites** — A single Shynet instance can support multiple users, each tracking multiple different sites. * **Multiple users and sites** — A single Shynet instance can support multiple users, each tracking multiple different sites
#### Tracking #### Tracking
@ -70,7 +70,7 @@ Here's the information Shynet can give you about your visitors:
#### Workflow #### Workflow
* **Collaboration built-in** — Administrators can easily share services with other users, as well * **Collaboration built-in** — Administrators can easily share services with other users, as well
* **Accounts (or not)** — Shynet has a fully featured account management workflow (powered by [Django Allauth](https://github.com/pennersr/django-allauth/)). * **Accounts (or not)** — Shynet has a fully featured account management workflow (powered by [Django Allauth](https://github.com/pennersr/django-allauth/))
## Recommendations ## Recommendations
@ -88,7 +88,7 @@ Shynet is pretty simple, but there are a few key terms you need to know in order
## Installation ## Installation
You can find installation instructions in our [Getting Started Guide](GUIDE.md#installation). You can find installation instructions in the [Getting Started Guide](GUIDE.md#installation).
## FAQ ## FAQ