Skip to content

Commit

Permalink
with the README
Browse files Browse the repository at this point in the history
  • Loading branch information
dav-m85 committed Jun 21, 2017
1 parent f6c5814 commit 65429b0
Showing 1 changed file with 18 additions and 0 deletions.
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# frankandoak/silo-documentation

Documentation module, comes with the PHP endpoint and the React component. Serves also the none markdown files.

## Usage

```php
$app->register(new \Silo\Documentation\Provider([
'/silo' => './vendor/frankandoak/silo/doc',
'' => './doc')
]));
```

```client
## Inside your routing file
const Doc = require('./../vendor-repo/frankandoak/silo-documentation').Doc;
ReactDOM.render(<Doc page={url.match(/\/doc(.*)$/)[1]}/>, document.getElementById('#doc'));
```

0 comments on commit 65429b0

Please sign in to comment.