Skip to content

docs: improve README #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #22

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


![solid-markdown-wasm](https://assets.solidjs.com/banner?type=solid-markdown-wasm&background=tiles&project=%20)

<p align="center">
Expand Down Expand Up @@ -319,11 +321,7 @@ You will need the following tools to compile from source
- [wasm-pack](https://github.com/rustwasm/wasm-pack "wasm-pack")
- [NodeJS/Bun](https://bun.sh/ "bun runtime")

Then run the following

```bash
bun run build
```
To compile the WASM runtime, run `wasm-pack build --target web --release` in the `markdown-renderer` directory. To build the JavaScript wrapper and bundle the package, run `bun run build` in the repository root.

## Performance Optimizations

Expand Down