From 630fa2cbb41e435295f476f854f67059a0448b9f Mon Sep 17 00:00:00 2001 From: Axel Berardino Date: Wed, 21 Aug 2019 10:48:12 +0200 Subject: [PATCH] Update documentation --- README.md | 10 ++++++++-- TODO | 2 +- data/template/parts/style.css.tmpl | 2 +- docs/index.md | 31 +++++++++++++++++++++++++++++- gen_demo.sh | 3 +++ 5 files changed, 43 insertions(+), 5 deletions(-) create mode 100644 gen_demo.sh diff --git a/README.md b/README.md index fc74e09..7cb2efd 100644 --- a/README.md +++ b/README.md @@ -61,16 +61,22 @@ To release new version, I'm using two scripts which generate the archives. For MacOS and Linux: ``` -./gen_bin.sh +./unix_release.sh ``` For Windows: ``` -win_gen_bin.bat +windows_release.bat ``` Then I attached the generated archives to a new release. +Then, I generate the demo files using: +``` +./gen_demo.sh +``` + + ### Working and debugging (more technical stuff!) If you want to work on this project or just change or improve something, you diff --git a/TODO b/TODO index 706289f..9e65c21 100644 --- a/TODO +++ b/TODO @@ -1,6 +1,6 @@ * More rigourous item description generation * Shop id for the link after shop generation - * Search bar? (lot of works, may easily be slow) + * Advanced query searching? (lots of work) * Minify generated files, reducing size. * Choose what tabs and characters to generate * By character name diff --git a/data/template/parts/style.css.tmpl b/data/template/parts/style.css.tmpl index ef1ec35..d2fb651 100644 --- a/data/template/parts/style.css.tmpl +++ b/data/template/parts/style.css.tmpl @@ -152,7 +152,7 @@ padding-right: 35px; padding-bottom: 35px; padding-top: 10px; - background: #191A17 url('https://www.pathofexile.com/image/profile/profile-full.jpg?1563488658105') no-repeat top left; + background: #0c0a0b url('https://www.pathofexile.com/image/profile/profile-full.jpg?1563488658105') no-repeat top left; } #main-page h1 { margin-top: 20px; diff --git a/docs/index.md b/docs/index.md index f53244e..f335c54 100644 --- a/docs/index.md +++ b/docs/index.md @@ -37,7 +37,7 @@ More detailed instructions for your system here: Want to see what generated files look like? -[See this one for example](http://0217021.free.fr/poe-stash/demo/cptpingu-standard-pc-2019-08-15.html) +[See this one for example](http://0217021.free.fr/poe-stash/demo/all_stash_types-standard.html) I generated some more here: [Demo and screenshots](http://0217021.free.fr/poe-stash) @@ -83,6 +83,35 @@ useful (at least for me!). Read some explanation here: [Pricing items](prices.md) +## Search + +It's possible to search for item's name, characteristic or type. Note that this +is a very naive search engine. By default everything is consider an "AND". The +"OR" can be use with the "|" symbol. + +Some example: + +Search for items with life on it: +``` +life +``` + +Search for items with 3 elements: +``` +fire cold lightning +``` + +Search for items with chaos or speed: +``` +chaos | speed +``` + +Search for a ring, an item name "Vix Lunaris" or everything which increase +damage: +``` +ring | vix lunaris | increased damage +``` + ## I need your help! I'm facing some issues, I could use a hand: diff --git a/gen_demo.sh b/gen_demo.sh new file mode 100644 index 0000000..9a4a904 --- /dev/null +++ b/gen_demo.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +go run cmd/cli/main.go --account all_stash_types --demo