summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJules Laplace <julescarbon@gmail.com>2021-02-18 17:52:09 +0100
committerJules Laplace <julescarbon@gmail.com>2021-02-18 17:52:09 +0100
commit744e5ee1bd4167fbff48253f34dd81733fd91443 (patch)
tree9c06287e12e5caf1196e477f72c20b18aa233ad5
parentce543a0985d9ea40710f6433122dc01df21671da (diff)
-rw-r--r--Readme.md29
1 files changed, 25 insertions, 4 deletions
diff --git a/Readme.md b/Readme.md
index 55d4d3e..5229fa3 100644
--- a/Readme.md
+++ b/Readme.md
@@ -1,19 +1,19 @@
# OKCMS
> "Pretty good"
+>
> - Steve Jobs
## To run:
-* npm install
-* cd examples
-* node index
+- npm install
+- cd examples
+- node index
Server will be running on http://lvh.me:1337/
Admin area available on http://lvh.me:1337/admin/
-
## Config
To access the admin area, you need to set a username and password.
@@ -26,8 +26,29 @@ OK_PASS=password
```
S3 needs to be configured in the same way:
+
```
S3_KEY=s3key
S3_SECRET=s3secret
S3_BUCKET=bucketname
```
+
+## Schema
+
+Valid datatypes include:
+
+- string
+- text
+- number
+- enum
+- foreign-key
+- video
+- image
+- date
+- flag
+- tag-list
+- link-list
+- media-list
+- captioned-image-list
+- double-captioned-image-list
+- meta