Skip to content
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

Jump to bottom

expand README #23

Open
rbuels opened this issue Mar 26, 2019 · 2 comments
Open

expand README #23

rbuels opened this issue Mar 26, 2019 · 2 comments

Comments

@rbuels
Copy link
Contributor

rbuels commented Mar 26, 2019

The README needs a lot of expansion.

In particular, need to document the options to getRecordsForRange: viewAsPairs, pairAcrossChr, maxInsertSize, and signal
@rbuels rbuels changed the title please expand README expand README Mar 26, 2019
@cmdcolin
Copy link
Collaborator

cmdcolin commented Apr 2, 2019

Added these elements. Could use more docs certainly but the options have been documented at a basic level

@cmdcolin
Copy link
Collaborator

cmdcolin commented Apr 9, 2019

Added a couple more things about the API just now

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@rbuels @cmdcolin