Update README.md

clarifies #1156
react-static · Apr 27, 2019 · c3a7e0c · c3a7e0c
1 parent 70e1f8c
commit c3a7e0c
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/react-static-plugin-source-filesystem/README.md b/packages/react-static-plugin-source-filesystem/README.md
@@ -2,6 +2,12 @@
 
 A [React-Static](https://react-static.js.org) plugin that adds support for recursively importing routes from a directory
 
+This means that any files in your projects `pages/` directory will be turned into static routes.
+
+Example: 
+- src/pages/index.js - would produce a route with the path of `/` and the template set to `src/pages/index.js`
+- src/pages/about/us.js - would produce a route with the page of `/about/us` and the template set to `src/pages/about/us.js`
+
 ## Installation
 
 In an existing react-static site run: