summaryrefslogtreecommitdiffstats
path: root/README.markdown
diff options
context:
space:
mode:
authorRomain d'Alverny <rda@hupstream.com>2012-06-23 22:31:35 +0200
committerRomain d'Alverny <rda@hupstream.com>2012-06-23 22:31:35 +0200
commit1af18af0150f51215f20cb3cd4c51c36e86145cd (patch)
tree25fdbb8fa72576381a216d1e25daf40ce2b07086 /README.markdown
parentd928ffae2e6d463336758d8a183b2ead87e0d433 (diff)
downloadplanet-1af18af0150f51215f20cb3cd4c51c36e86145cd.tar
planet-1af18af0150f51215f20cb3cd4c51c36e86145cd.tar.gz
planet-1af18af0150f51215f20cb3cd4c51c36e86145cd.tar.bz2
planet-1af18af0150f51215f20cb3cd4c51c36e86145cd.tar.xz
planet-1af18af0150f51215f20cb3cd4c51c36e86145cd.zip
Option to show only posts that have a specific tag or category.
- add configuration description in README.markdown - add unit test with testmore.php for this very feature
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown22
1 files changed, 22 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index 1427f69..84d5c74 100644
--- a/README.markdown
+++ b/README.markdown
@@ -17,3 +17,25 @@ Web hosting with PHP5 (PHP4 will not work).
License
-------
Moonmoon is free software and is released under BSD license.
+
+
+Configuration options
+---------------------
+After installation, configuration is kept in a YAML formatted ```custom/config.yml```:
+
+```%yaml
+url: http://planet.example.net # your planet base URL
+name: My Planet # your planet front page name
+locale: en # front page locale
+items: 10 # how many items to show
+refresh: 240 # feeds cache timeout (in seconds)
+cache: 10 # front page cache timeout (in seconds)
+cachedir: ./cache # where is cache stored
+postmaxlength: 0 # deprecated
+shuffle: 0 # deprecated
+nohtml: 0 # deprecated
+categories: # only list posts that have one
+ # of these (tag or category)
+```
+
+--- \ No newline at end of file