Currently in development; ultimately, this will be a library that people can use to create their own mure web editors / tools. Its goal is to standardize synced (via PouchDB / CouchDB) graphics, selection, and metadata changes between any other open mure apps.
As specific types of metadata (embedded datasets, bindings, etc) become standardized across apps, some core functionality associated with that metadata may be absorbed here as well.
For basic use in the browser:
For server-side apps or pre-bundled browser apps:
npm install mure
However, for the latter, be advised that some of the dependencies of this library result in webpack / rollup / whatever configuration hell. If you discover a configuration that actually works, I'd love to hear about it!
See the boilerplate app for a basic example for how to use the library to create a mure editor
git clone https://github.com/mure-apps/mure-library.gitcd mure-librarynpm installnpm run build
For now, just use symlinks to the dist/ folder; worry about
npm link / app-level bundling in the future
Releasing a new version
A list of reminders to make sure I don't forget any steps:
- Update the version in package.json
- Update the release link in this README
npm run test
git commit -a -m "commit message"
- (Verify Travis CI doesn't fail)
git tag -a #.#.# -m "tag annotation"
git push --tags
- (maybe optional) Edit / document the release on Github, add built files in