Skip to content

Commit

Permalink
added demo video to README
Browse files Browse the repository at this point in the history
  • Loading branch information
Sammy Saglam committed Mar 30, 2018
1 parent bab0096 commit 3f15e21
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
18 changes: 6 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,22 +22,16 @@ import SomeMarkdownFile from "./SomeMarkdownFile.md";
> - Webpack
> - React 16.2.0 or greater
## Basic Usage Example
## Usage Demo Video
The below demo video will demonstrate how to document any component; in the
below example I used [ReactTable](https://react-table.js.org/#/story/readme)
by **react-tools**

### Screenshot:
![Basic Usage Example](/SCREENSHOTS/show-source.png?raw=true "Basic Usage Example")
![Usage Example](/SCREENSHOTS/main-demo.gif?raw=true "Usage Example")


### Source:
"SomeMarkdownFile.md" :
```md
# A title

```jsx show-source
<div>Hello</div>
``` .
```

## Importing Markdown file example:
"App.js" :
```javascript
import SomeMarkdownFile from "./SomeMarkdownFile.md";
Expand Down
Binary file added SCREENSHOTS/main-demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3f15e21

Please sign in to comment.