Add readme

This commit is contained in:
Christian Bundy 2019-06-24 12:19:06 -07:00
parent 5a915afd7b
commit d447d57d90
No known key found for this signature in database
GPG Key ID: EB541AAEF4366237

38
README.md Normal file
View File

@ -0,0 +1,38 @@
# Oasis
> friendly neighborhood scuttlebutt interface
A small Scuttlebutt interface built on HTML, CSS, and Node.js without any
front-end JavaScript. Simple, accessible, and easy to maintain (hopefully!).
## Usage
```shell
oasis
```
## Installation
With [npm](https://npmjs.org/):
```shell
npm -g install oasis
```
With [yarn](https://yarnpkg.com/en/):
```shell
yarn global add oasis
```
## See Also
- [patchbay](https://github.com/ssbc/patchbay)
- [patchwork](https://github.com/ssbc/patchwork)
- [ssb-server](https://github.com/ssbc/ssb-server)
- [yap](https://github.com/dominictarr/yap)
## License
ISC