Update README.md

This commit is contained in:
AJ ONeal 2017-08-02 15:45:21 -06:00
parent 45f1d38592
commit de452d097d
1 changed files with 6 additions and 15 deletions

View File

@ -46,6 +46,8 @@ Application Features
* Multi-Tentated Application Management * Multi-Tentated Application Management
* Built-in OAuth2 & OAuth3 support * Built-in OAuth2 & OAuth3 support
Currently being tested with Ubuntu, Raspbian, and Debian on Digital Ocean, Raspberry Pi, and Heroku.
Installation Installation
------------ ------------
@ -54,17 +56,10 @@ See [INSTALL.md](https://git.daplie.com/Daplie/walnut.js/blob/master/INSTALL.md)
API API
--- ---
API docs are here https://git.daplie.com/Daplie/com.example.hello See [API.md](https://git.daplie.com/Daplie/walnut.js/blob/master/API.md)
Understanding Walnut
``` ====================
req.apiUrlPrefix => https://api.example.com/api/tld.domain.pkg
```
Structure
=====
Currently being tested with Ubuntu, Raspbian, and Debian on Digital Ocean, Raspberry Pi, and Heroku.
``` ```
/srv/walnut/ /srv/walnut/
@ -72,7 +67,6 @@ Currently being tested with Ubuntu, Raspbian, and Debian on Digital Ocean, Raspb
├── core ├── core
│ ├── bin │ ├── bin
│ ├── boot │ ├── boot
│ ├── holepunch
│ └── lib │ └── lib
├── etc ├── etc
│ └── client-api-grants │ └── client-api-grants
@ -103,9 +97,6 @@ Will install to
/etc/tmpfiles.d/walnut.conf /etc/tmpfiles.d/walnut.conf
``` ```
Implementation details
----------------
Initialization Initialization
-------------- --------------
@ -179,7 +170,7 @@ Once you run the app the initialization files will appear in these locations
/srv/walnut/config/<domain.tld>/config.json /srv/walnut/config/<domain.tld>/config.json
``` ```
Deleting those files will rese Deleting those files and restarting walnut will reset it to its bootstrap state.
Accessing static apps Accessing static apps
--------------------- ---------------------