Add usage link to readme

Platoniq · Jan 24, 2020 · 4800178 · 4800178
1 parent f8f24bd
commit 4800178
Show file tree

Hide file tree

Showing 13 changed files with 28 additions and 15 deletions.
diff --git a/README.md b/README.md
@@ -13,6 +13,8 @@ Allows to map processes to image parts using maps.
 NavigationMaps is available as a Content Block widget (currently for the
 homepage only).
 
+👉 [Check the usage guide here!](USAGE.md)
+
 ![Admin editor](examples/admin.gif)
 
 ## Installation

diff --git a/USAGE.md b/USAGE.md
@@ -1,44 +1,55 @@
-# Using Navigation Maps 
- 
+# Using Navigation Maps
+
 Platoniq has come out with a new feature for the Decidim platform, Navigation Maps! This feature allows the administrator to post layouts that display multiple blueprints or maps and highlight sections in which a team or community is working. Participants can then click on these highlighted sections to access processes/assemblies/consultations attached to the space.
 
 This feature is currently available to put on your homepage. Let's check out how!
 
-First you will need to click on settings at the left hand side of your dashboard and then click homepage. 
-![0](0.png)
+First you will need to click on settings at the left hand side of your dashboard and then click homepage.
+
+![figure 0](examples/guide/0.png)
 
 Then you will see Navigation Maps
-![1](1.png)
+
+![figure 1](examples/guide/1.png)
 
 You will need do drag 'Navigation Maps' to 'Active Content Blocks'
-![2](2.png)
+
+![figure 2](examples/guide/2.png)
 
 Then click on the pencil icon within the blocks to get started editing
-![3](3.png)
+
+![figure 3](examples/guide/3.png)
 
 To upload a layout, blueprint, or map click '+ADD'
-![4](4.png)
+
+![figure 4](examples/guide/4.png)
 
 Then you will need to give the section a title and upload your image where it says 'blueprint image'. Then click update.
-![5](5.png)
+
+![figure 5](examples/guide/5.png)
 
 When you click 'Map Editor' an image of your blueprint should show up with tools on the left hand side for you to select and area of the layout
-![6.2](6.2.png)
+
+![figure 6.2](examples/guide/6.2.png)
 
 Use the square icon to highlight rectangular or square spaces and triangular icon to create new forms or shapes, the icon with the arrow lets you adjust the shape
 
 When you've highlighted the area in which you will be working, click update:
-![6.3](6.3.png)
+
+![figure 6.3](examples/guide/6.3.png)
 
 Click the area you've highlighted on your layout:
-![6.4](6.4.png)
 
-A new space to edit the layout should appear. 
-![6.5](6.5.png)
+![figure 6.4](examples/guide/6.4.png)
+
+A new space to edit the layout should appear.
+
+![figure 6.5](examples/guide/6.5.png)
 
 Title the layout, give a short description that fits your project, and link to the process/assembly/consultation where you and your team or community will decide what happens to the space. Don't forget to save your changes.
 
 Now on your homepage this is how the layout should appear:
-![6.6](6.6.png)
+
+![figure 6.6](examples/guide/6.6.png)
 
 The 'Take Part' button will send the participant to the link that you've added.
diff --git a/0.png → examples/guide/0.png b/0.png → examples/guide/0.png
diff --git a/1.png → examples/guide/1.png b/1.png → examples/guide/1.png
diff --git a/2.png → examples/guide/2.png b/2.png → examples/guide/2.png
diff --git a/3.png → examples/guide/3.png b/3.png → examples/guide/3.png
diff --git a/4.png → examples/guide/4.png b/4.png → examples/guide/4.png
diff --git a/5.png → examples/guide/5.png b/5.png → examples/guide/5.png
diff --git a/6.2.png → examples/guide/6.2.png b/6.2.png → examples/guide/6.2.png
diff --git a/6.3.png → examples/guide/6.3.png b/6.3.png → examples/guide/6.3.png
diff --git a/6.4.png → examples/guide/6.4.png b/6.4.png → examples/guide/6.4.png
diff --git a/6.5.png → examples/guide/6.5.png b/6.5.png → examples/guide/6.5.png
diff --git a/6.6.png → examples/guide/6.6.png b/6.6.png → examples/guide/6.6.png