aboutsummaryrefslogtreecommitdiffstats
path: root/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'index.html')
-rw-r--r--index.html42
1 files changed, 42 insertions, 0 deletions
diff --git a/index.html b/index.html
index 5ec2753..82fa43f 100644
--- a/index.html
+++ b/index.html
@@ -100,6 +100,48 @@
<p class="tab">text for button 3</p>
<input type="radio" name="test" class="selecttab"/>
<p class="tab">text for button 4</p>-->
+ <h2>The Basics</h2>
+ <hr/>
+ <p>The chip searcher is a simple program.
+ To get started, simply type the name of the chip you'd like to know about into the top box.
+ By default, the searcher will automatically refresh the results as you type.</p>
+ <h4>Different types of chips</h4>
+ <ul>
+ <li><b>Beta Chips</b> are indicated by a β symbol.</li>
+ <li><b>Soon-to-be deprecated Chips</b> are indicated by yellow text, as well as a warning.</li>
+ <li><b>Deprecated Chips</b> are indicated by red text, as well as a warning.</li>
+ </ul>
+ <p>Neither form of deprecated chip will display by default.</p>
+ <h2>Options</h2>
+ <hr/>
+ <p>The chip searcher supports the following configuration
+ options, contained in the fold-out menu below the search bar.</p>
+ <h4>Toggles</h4>
+ <hr/>
+ <ul>
+ <li><b>Auto Refresh</b>: Automatically update search results as you type.
+ When disabled, hit <kbd>Enter</kbd> to refresh.</li>
+ <li><b>Show Beta Chips</b>: When enabled, beta chips will be included in the search.</li>
+ <li><b>Show Deprecated Chips</b>: When enabled, deprecated chips will be included in the search.</li>
+ <li><b>Enable Filter Suggestions</b>: When enabled, filters will be displayed as autocomplete options.</li>
+ </ul>
+ <h4>Fuzzy Finder</h4>
+ <hr/>
+ <ul>
+ <li><b>Exact Match</b>: What is typed must appear identically in the results.</li>
+ <li><b>Small Typos</b>: Small errors are ignored, though larger ones will still affect the results.</li>
+ <li><b>Loose Match</b>: Really only useful if you can't spell.</li>
+ </ul>
+ <h4>Search By</h4>
+ <hr/>
+ <ul>
+ <li><b>Name</b>: Search for what is typed in the chip name.</li>
+ <li><b>Description</b>: Search for what is typed in the chip description</li>
+ </ul>
+ <h4>Items Per Page</h4>
+ <hr/>
+ <p>Configures the number of items that will appear in each page. Defaults to 12.</p>
+ </div>
</details>
</body>
</html> \ No newline at end of file