瀏覽代碼

updated readme file

bmallred 9 年之前
父節點
當前提交
02291b83d2
共有 1 個文件被更改,包括 10 次插入10 次删除
  1. 10 10
      README.md

+ 10 - 10
README.md

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