bwsample/README.md

The JS implementation of the pypi package bwsample

[![npm version](https://badge.fury.io/js/bwsample.svg)](https://badge.fury.io/js/bwsample)
[![Join the chat at https://gitter.im/satzbeleg/community](https://badges.gitter.im/satzbeleg/community.svg)](https://gitter.im/satzbeleg/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

# bwsample-js
Javascript implementation of bwsample to run in a browser.

## Important Note
Variable and function names do not comply with JS conventions (e.g. camel case). We kept the same variable and function names as in the Python package [bwsample](https://pypi.org/project/bwsample/).

We are using 
- `snake_case`: variable names 
- `kebab-case`: JSON keys
- `camelCase`: function names, class names

## Appendix

## Misc commands
- Login into yarn: `yarn login`
- Publish the package: `yarn publish` 

### Support
Please [open an issue](https://github.com/satzbeleg/bwsample-js/issues/new) for support.

### Contributing
Please contribute using [Github Flow](https://guides.github.com/introduction/flow/). Create a branch, add commits, and [open a pull request](https://github.com/satzbeleg/bwsample-js/compare/).

### Acknowledgements
This work was funded by the Deutsche Forschungsgemeinschaft (DFG, German Research Foundation) - [433249742](https://gepris.dfg.de/gepris/projekt/433249742). Project duration: 2020-2023.

### Citation
Please cite the peer-reviewed JOSS paper [![DOI](https://joss.theoj.org/papers/10.21105/joss.03324/status.svg)](https://doi.org/10.21105/joss.03324) when using this software for any purpose. Please note that the Javascript version of `bwsample` was **not** subject to the JOSS review.