Skip to content

Commit 8b46e04

Browse files
committed
(docs): add a CodeSandbox playground, reorg Example section
- Link to the CodeSandbox that's generated via the `cra-example` branch - Combine the Example and Demo sections into one - Makes more sense than adding a third "Playground" or "CodeSandbox" section - Condense and remove some extraneous information too - Should make a little more sense / be more explicit that they're all the same example just hosted / viewed different ways - hence singular Example, not Examples - resolves #32
1 parent c4db69d commit 8b46e04

File tree

1 file changed

+8
-14
lines changed

1 file changed

+8
-14
lines changed

README.md

Lines changed: 8 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -98,17 +98,11 @@ The API methods are _mostly_ just wrappers around [`signature_pad`'s API](https:
9898

9999
## Example
100100

101-
Have a look at the [`example/`](example/) directory.
102-
103-
This example can be run with:
104-
105-
```bash
106-
npm start
107-
```
108-
109-
followed by navigating to [http://localhost:8080/](http://localhost:8080/) in your browser to view it.
110-
111-
## [Demo](https://agilgur5.github.io/react-signature-canvas/)
112-
113-
[View the live demo here](https://agilgur5.github.io/react-signature-canvas/).
114-
Hosted via the [`gh-pages` branch](https://github.com/agilgur5/react-signature-canvas/tree/gh-pages), which has a standalone version of the code in [`example/`](example/).
101+
You can interact with the example in a few different ways:
102+
103+
1. Run `npm start` and navigate to [http://localhost:8080/](http://localhost:8080/).<br>
104+
Hosted locally via the [`example/`](example/) directory
105+
1. [View the live demo here](https://agilgur5.github.io/react-signature-canvas/).<br>
106+
Hosted via the [`gh-pages` branch](https://github.com/agilgur5/react-signature-canvas/tree/gh-pages), a standalone version of the code in [`example/`](example/)
107+
1. [Play with the CodeSandbox here](https://codesandbox.io/s/github/agilgur5/react-signature-canvas/tree/cra-example).<br>
108+
Hosted via the [`cra-example` branch](https://github.com/agilgur5/react-signature-canvas/tree/gh-pages), a standalone version using [Create React App](https://github.com/facebook/create-react-app).

0 commit comments

Comments
 (0)