Skip to content

Commit

Permalink
Improve READMEs a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
jcreedcmu committed Mar 23, 2024
1 parent 2174648 commit b478986
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 5 deletions.
4 changes: 4 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,10 @@ test:
npm run test-watch

# publish to npm
publish:
git push origin "main:publish"

# publish to npm, called by ci
ci-publish:
make build-lib
mv README.npm-lib.md README.md
Expand Down
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,3 +41,13 @@ make wasm
```
rebuilds the `twelf.wasm` asset in docker. This artefact is also checked into the repository,
and it similarly does not need to be built from a fresh checkout.

```shell
make deploy
```
pushes to the `deploy` branch, which causes [this Actions workflow](.github/workflows/static.yml) to rebuild the [static site](https://jcreedcmu.github.io/twelf-wasm).

```shell
make publish
```
pushes to the `publish` branch, which causes [this Actions workflow](.github/workflows/publish.yml) to publish [the npm package](https://www.npmjs.com/package/twelf-wasm).
12 changes: 7 additions & 5 deletions README.npm-lib.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,10 @@
Twelf on Wasm Support
=====================

What we publish as an npm library as package `twelf-wasm` is just a
small library. The intended use is for libary users (specifically the
Twelf wiki) to conveniently construct url-fragment arguments with the
`encode` function so that they can link to twelf-wasm and have it load
a particular bit of twelf code at startup.
This npm package `twelf-wasm` is a small library so that callers
(specifically the Twelf wiki) can conveniently construct url-fragment
arguments with the `encode` function so that they can link to
twelf-wasm and have it load a particular bit of twelf code at startup.

See the main README at https://github.com/jcreedcmu/twelf-wasm for
more details.

0 comments on commit b478986

Please sign in to comment.