Add readme
This commit is contained in:
parent
5a915afd7b
commit
d447d57d90
38
README.md
Normal file
38
README.md
Normal 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
|
||||
|
Loading…
Reference in New Issue
Block a user