Skip to content

Commit

Permalink
improved docs
Browse files Browse the repository at this point in the history
  • Loading branch information
therealadityashankar committed Jul 12, 2020
1 parent b62f7c0 commit a3d2b10
Showing 1 changed file with 13 additions and 7 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,26 +6,32 @@ go up, go down, now turn left, nope its not there

## Installation

todo

script tags:
```html
<script type="module" src="https://cdn.jsdelivr.net/gh/vanillawc/wc-router@0/src/index.js">
```
## Usage NOTE
- production ready: **nope**, definitely not
- lazy loading is default behaviour, put the "eager" attribute to change this !,

## Usage example


## testing
- install [deno](https://deno.land/#installation)
- install [velociraptor](https://github.com/umbopepato/velociraptor)
- run the test file with `vr test`
- open `localhost:8000` in a browser
### Tags
- `<wc-router-options>`
- `<wc-router>`
- `<wc-route>`
- `<r-a>`
### Routing
## Usage example
```html
<wc-router>
Expand All @@ -39,7 +45,7 @@ todo
### Linking
```html
<wc-ra href="/page3"></wc-ra>
<r-a href="/page3"></r-a>
```
## Attributes
Expand Down

0 comments on commit a3d2b10

Please sign in to comment.