Skip to content

Commit

Permalink
Add developer docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
mathewjordan committed Apr 8, 2024
1 parent 9a4fe4e commit d0a0e23
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# use-markdown
# @nulib/use-markdown

React hook for handling of Markdown in web applications with support for [GitHub flavored markdown](https://github.github.com/gfm/) content.

Expand Down Expand Up @@ -27,3 +27,22 @@ const MyComponent = () => {

export default MyComponent;
```

## Development

Run in development environment.

```sh
npm i
npm run dev
```

A browser session will begin:

```sh
VITE v5.2.8 ready in 84 ms

➜ Local: http://localhost:5173/
➜ Network: use --host to expose
➜ press h + enter to show help
```

0 comments on commit d0a0e23

Please sign in to comment.