From 8ff1cb598f79d5b34957b40b4c9ad6afcf7376a7 Mon Sep 17 00:00:00 2001
From: Thomas--S <info@thomas-stangl.de>
Date: Sun, 4 Mar 2018 12:41:55 +0100
Subject: [PATCH] Update documentation

---
 CHANGELOG.md      |  5 ++++
 stairsplus/API.md | 59 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 64 insertions(+)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f720912..5ad0dca 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ### Added
 
 - Listring add for circular saw.
+- Stairs+: New API function:
+ `stairsplus:register_custom_subset(subset, modname, subname, recipeitem, fields)`
 
 ### Fixed
 
@@ -22,6 +24,9 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - New craft for:
   - Stone Tile
   - Circle Stone Bricks
+- Stairs+:
+  - Move definitions to `stairsplus.defs` table in a separate file
+  - Move recipe definitions to `stairsplus.register_recipes` function in a separate file
 
 ## [1.1.0] - 2017-10-04
 
diff --git a/stairsplus/API.md b/stairsplus/API.md
index 1011487..cd8d1a7 100644
--- a/stairsplus/API.md
+++ b/stairsplus/API.md
@@ -20,4 +20,63 @@ You will probably never want to use them directly:
 * `stairsplus:register_slab(modname, subname, recipeitem, fields)`
 * `stairsplus:register_panel(modname, subname, recipeitem, fields)`
 * `stairsplus:register_micro(modname, subname, recipeitem, fields)`
+* `stairsplus:register_slope(modname, subname, recipeitem, fields)`
 
+If you only want to register a subset of stairsplus nodes,
+you can use the `stairsplus:register_custom_subset(subset, modname, subname, recipeitem, fields)` function.
+The subset table should have the following format:
+
+```lua
+    local subset = {
+    	{ "micro", "" },
+    	{ "micro", "_1" },
+    	{ "micro", "_2" },
+    	{ "micro", "_4" },
+    	{ "micro", "_12" },
+    	{ "micro", "_14" },
+    	{ "micro", "_15" },
+    	{ "panel", "" },
+    	{ "panel", "_1" },
+    	{ "panel", "_2" },
+    	{ "panel", "_4" },
+    	{ "panel", "_12" },
+    	{ "panel", "_14" },
+    	{ "panel", "_15" },
+    	{ "slab",  "" },
+    	{ "slab",  "_quarter" },
+    	{ "slab",  "_three_quarter" },
+    	{ "slab",  "_1" },
+    	{ "slab",  "_2" },
+    	{ "slab",  "_14" },
+    	{ "slab",  "_15" },
+    	{ "slab",  "_two_sides" },
+    	{ "slab",  "_three_sides" },
+    	{ "slab",  "_three_sides_u" },
+    	{ "slope", "" },
+    	{ "slope", "_half" },
+    	{ "slope", "_half_raised" },
+    	{ "slope", "_inner" },
+    	{ "slope", "_inner_half" },
+    	{ "slope", "_inner_half_raised" },
+    	{ "slope", "_inner_cut" },
+    	{ "slope", "_inner_cut_half" },
+    	{ "slope", "_inner_cut_half_raised" },
+    	{ "slope", "_outer" },
+    	{ "slope", "_outer_half" },
+    	{ "slope", "_outer_half_raised" },
+    	{ "slope", "_outer_cut" },
+    	{ "slope", "_outer_cut_half" },
+    	{ "slope", "_outer_cut_half_raised" },
+    	{ "slope", "_cut" },
+    	{ "stair", "" },
+    	{ "stair", "_half" },
+    	{ "stair", "_right_half" },
+    	{ "stair", "_inner" },
+    	{ "stair", "_outer" },
+    	{ "stair", "_alt" },
+    	{ "stair", "_alt_1" },
+    	{ "stair", "_alt_2" },
+    	{ "stair", "_alt_4" },
+    }
+```
+You can remove entries as needed.
\ No newline at end of file