1
0
mirror of https://github.com/jfilter/clean-text.git synced 2021-09-19 22:32:58 +03:00

improve README

This commit is contained in:
Johannes Filter
2019-03-25 11:52:22 +01:00
parent 4d77cc7d6d
commit c813fc4df0

View File

@@ -6,6 +6,30 @@ Based on [https://github.com/chartbeat-labs/textacy](Textacy)'s `preprocess`.
`pip install -U git+https://github.com/jfilter/clean-text#egg=cleantext`
## Development
- install [Pipenv](https://pipenv.readthedocs.io/en/latest/)
- ```bash
git clone https://github.com/jfilter/clean-text && cd clean-text && pipenv install
```
- to run test: ```bash
pipenv run pytest
```
## Contributing
If you have a **question**, found a **bug** or want to propose a new **feature**, have a look at the [issues page](https://github.com/jfilter/clean-text/issues).
**Pull requests** are especially welcomed when they fix bugs or improve the code quality.
If something breaks, consider adding a [test](https://github.com/jfilter/clean-text/tree/master/tests) with your specific input.
## Acknowledgements
Built upon the work by [Burton DeWilde](https://github.com/bdewilde)'s [Textacy](https://github.com/chartbeat-labs/textacy).
## License
Apache
```