Browse Source

updated readme

bmallred 9 years ago
parent
commit
d94532e2fb
1 changed files with 41 additions and 0 deletions
  1. 41 0
      README.md

+ 41 - 0
README.md

@ -1,3 +1,44 @@
1 1
loop
2 2
====
3 3
4
Basic Structure
5
===============
6
7
./users
8
-------
9
10
User name and hashed password security. Not the best but definitely simple.
11
12
./user/content/{unique-id}
13
--------------------------
14
15
This directory holds the core data. Essentially every editable item has a unique identifier which then holds the
16
data specific to it. By default every new item will contain a default markdown file. Ex:
17
18
    - document.md
19
    - kittens.gif
20
    - uberawesomeness.odt
21
22
./user/blog
23
-----------
24
25
The blog directory contains symbolic links to content which has been marked as a public entry. The format of the file
26
name gives the unique title of the blog entry. Ex:
27
28
    - 201501010730-my-first-blog-post -> ../content/yaddayaddayadda
29
30
./user/calendar
31
---------------
32
33
The calendar name will be represented in the file name with the file extension .ics. Ex:
34
35
    - Employee Work Items.ics
36
    - Personal.ics
37
38
Environment Variables
39
=====================
40
41
    - LOOP_URL      (Default: localhost:6006)
42
    - LOOP_SALT     (Default: whatyoutalkingaboutwillus)
43
    - LOOP_BASE     (Default: .)
44