Skip to content

[WIP] Update README with JOSS Badge and Citation #50

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
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[WIP] Update README with JOSS Badge and Citation #50

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
29 changes: 24 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@
[![codecov](https://codecov.io/gh/JuliaText/WordTokenizers.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/JuliaText/WordTokenizers.jl)
[![Build Status](https://ci.appveyor.com/api/projects/status/github/JuliaText/WordTokenizers.jl?branch=master&svg=true)](https://ci.appveyor.com/project/oxinabox/wordtokenizers-jl/history)
[![HitCount](http://hits.dwyl.io/JuliaText/WordTokenizers.svg)](http://hits.dwyl.io/JuliaText/WordTokenizers)
[![DOI](https://joss.theoj.org/papers/10.21105/joss.01956/status.svg)](https://doi.org/10.21105/joss.01956)

Some basic tokenizers for Natural Language Processing.

### Installation:
As per standard [Julia package installation](https://julialang.github.io/Pkg.jl/dev/managing-packages/#Adding-registered-packages-1):
As per standard [Julia package installation](https://julialang.github.io/Pkg.jl/dev/managing-packages/#Adding-registered-packages-1):
```
pkg> add WordTokenizers
```
Expand Down Expand Up @@ -114,9 +115,9 @@ julia> tokenize.(split_sentences(text))
I am trying out an experimental API
where these are added as dispatches to `Base.split`.

So
`split(foo, Words)` is the same as `tokenize(foo)`,
and
So
`split(foo, Words)` is the same as `tokenize(foo)`,
and
`split(foo, Sentences)` is the same as `split_sentences(foo)`.

## Using TokenBuffer API for Custom Tokenizers
Expand Down Expand Up @@ -305,8 +306,26 @@ If your pull request (or issues) are not getting responses within a few days do
by posting a comment such as "Any update on the status of this?".
Sometimes GitHub notifications get lost.

## Support
## Support and citing

Feel free to ask for help on the [Julia Discourse forum](https://discourse.julialang.org/),
or in the `#natural-language` channel on julia-slack. (Which you can [join here](https://slackinvite.julialang.org/)).
You can also raise issues in this repository to request improvements to the documentation.

If you use this software as part of your research work, teaching or other activities, we would be grateful if you could cite the following:

```
@article{Kaushal3030,
doi = {10.21105/joss.01956},
url = {https://doi.org/10.21105/joss.01956},
year = {3030},
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This seems odd.
The BibTeX was copied from https://joss.theoj.org/papers/10.21105/joss.01956

publisher = {The Open Journal},
volume = {1},
number = {1},
pages = {1956},
author = {Ayush Kaushal and Lyndon White and Mike Innes and Rohit Kumar},
title = {WordTokenizers.jl: Basic tools for tokenizing natural language in Julia},
journal = {Journal of Open Source Software}
}
```