From 1c3e86613a13296db7022637d44cf05119bfb020 Mon Sep 17 00:00:00 2001 From: shprink Date: Wed, 22 Jul 2015 11:03:15 -0500 Subject: [PATCH] fix documentation --- CONFIGURATION.md | 17 +++++++++++++++++ DEVELOPMENT.md | 2 +- INSTALLATION.md | 2 -- config.json.dist | 2 +- config.xml.dist | 2 +- 5 files changed, 20 insertions(+), 5 deletions(-) diff --git a/CONFIGURATION.md b/CONFIGURATION.md index da63fc3e8..5cf249308 100644 --- a/CONFIGURATION.md +++ b/CONFIGURATION.md @@ -97,6 +97,11 @@ They are three types of mnu item (internal|external|separator). "trans": "menu.tags", "route": "public.taxonomies({ term: 'post_tag' })", "icon": "icon ion-pricetags" +}, { + "type": "internal", + "trans": "menu.bookmarks", + "route": "public.bookmarks", + "icon": "icon ion-bookmark" }, { "type": "separator", "trans": "Separator" @@ -170,6 +175,18 @@ NB: For now the homepage is mandatory and cannot be a specific page. } ``` +### Bookmark + +The bookmark cache has a difference from others. maxAge is infinite and cannot be overwritten. + +``` +"bookmark": { // Overwrite global cache. Can be empty + "cache": { + "capacity": 10 + } +}, +``` + ### taxonomies ``` diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md index f8329b695..9cebb4bd7 100644 --- a/DEVELOPMENT.md +++ b/DEVELOPMENT.md @@ -10,4 +10,4 @@ live reload in memory (no files are dumped in www folder) npm run devserver ``` -Open http://localhost:9100/ and check if everything run as expected. +Open http://localhost:8080/ and check if everything run as expected. diff --git a/INSTALLATION.md b/INSTALLATION.md index fcd08e881..c57a83a69 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -35,8 +35,6 @@ sh ./install.sh ### Config files -Now that the installation is done two files - There are two config files, ```config.json``` for the application configuration and ```config.scss``` for the style configuration. ### Installing the Web service diff --git a/config.json.dist b/config.json.dist index 825460283..83a1f985d 100644 --- a/config.json.dist +++ b/config.json.dist @@ -1,7 +1,7 @@ { "api": { "baseUrl": "http://yourDomain.com/wp-json", - "timeout": 3000, + "timeout": 10000, "maxAttempt": 3 }, "debugEnabled" : false, diff --git a/config.xml.dist b/config.xml.dist index f1029ef5f..5e97314c7 100644 --- a/config.xml.dist +++ b/config.xml.dist @@ -1,5 +1,5 @@ - + YourAppName Your description.