Skip to content

Commit

Permalink
Make README and HUMANS consistent with that of Bio
Browse files Browse the repository at this point in the history
  • Loading branch information
Ben J. Ward committed Jun 15, 2018
1 parent 37abec4 commit 63b0b88
Show file tree
Hide file tree
Showing 2 changed files with 53 additions and 10 deletions.
2 changes: 1 addition & 1 deletion HUMANS.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# The humans responsible for BioAlignments

## BioAlignments.jl Maintainers
## Maintainers
- Ben J. Ward
- GitHub: [BenJWard](https://github.com/BenJWard)
- Email: [email protected]
Expand Down
61 changes: 52 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,21 @@
# BioAlignments

[![latest release](https://img.shields.io/github/release/BioJulia/BioAlignments.jl.svg?style=flat-square)](https://github.com/BioJulia/BioAlignments.jl/releases/latest)
[![Latest release](https://img.shields.io/github/release/BioJulia/BioAlignments.jl.svg?style=flat-square)](https://github.com/BioJulia/BioAlignments.jl/releases/latest)
[![MIT license](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square)](https://github.com/BioJulia/BioAlignments.jl/blob/master/LICENSE)
[![stable documentation](https://img.shields.io/badge/docs-stable-blue.svg?style=flat-square)](https://biojulia.github.io/BioAlignments.jl/stable)
[![latest documentation](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://biojulia.github.io/BioAlignments.jl/latest/)
![lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg?style=flat-square)
[![Stable documentation](https://img.shields.io/badge/docs-stable-blue.svg?style=flat-square)](https://biojulia.github.io/BioAlignments.jl/stable)
[![Latest documentation](https://img.shields.io/badge/docs-latest-blue.svg?style=flat-square)](https://biojulia.github.io/BioAlignments.jl/latest/)
![Lifecycle](https://img.shields.io/badge/lifecycle-maturing-blue.svg?style=flat-square)
[![Chat on Discord](https://img.shields.io/badge/discord-chat-blue.svg?style=flat-square&logo=discord&colorB=%237289DA)](https://discord.gg/z73YNFz)
[![Backers on Open Collective](oc-backers-img)](#backers)
[![Sponsors on Open Collective](oc-sponsors-img)](#sponsors)


## Description

BioAlignments provides alignment algorithms, data structures, and I/O
tools for SAM and BAM file formats.


## Installation

Install BioAlignments from the Julia REPL:
Expand All @@ -25,23 +29,62 @@ add("BioAlignments")
If you are interested in the cutting edge of the development, please
check out the master branch to try new features before release.


## Testing

BioAlignments is tested against julia `0.6` and current `0.7-dev` on
Linux, OS X, and Windows.

| **Latest release** | **Latest build status** |
|:------------------:|:-----------------------:|
| [![julia06](http://pkg.julialang.org/badges/BioAlignments_0.6.svg?style=flat-square)](http://pkg.julialang.org/?pkg=BioAlignments) [![julia07](http://pkg.julialang.org/badges/BioAlignments_0.7.svg?style=flat-square)](http://pkg.julialang.org/?pkg=BioAlignments) | [![travis](https://img.shields.io/travis/BioJulia/BioAlignments.jl/master.svg?label=Linux+/+macOS)](https://travis-ci.org/BioJulia/BioAlignments.jl) [![appveyor](https://ci.appveyor.com/api/projects/status/klkynmkr1tgd30gq/branch/master?svg=true)](https://ci.appveyor.com/project/Ward9250/bioalignments-jl/branch/master) [![coverage](http://codecov.io/github/BioJulia/BioAlignments.jl/coverage.svg?branch=master)](http://codecov.io/github/BioJulia/BioAlignments.jl?branch=master) |
| [![julia06](http://pkg.julialang.org/badges/BioAlignments_0.6.svg)](http://pkg.julialang.org/?pkg=BioAlignments) [![julia07](http://pkg.julialang.org/badges/BioAlignments_0.7.svg)](http://pkg.julialang.org/?pkg=BioAlignments) | [![travis](https://img.shields.io/travis/BioJulia/BioAlignments.jl/master.svg?label=Linux+/+macOS)](https://travis-ci.org/BioJulia/BioAlignments.jl) [![appveyor](https://ci.appveyor.com/api/projects/status/klkynmkr1tgd30gq/branch/master?svg=true)](https://ci.appveyor.com/project/Ward9250/bioalignments-jl/branch/master) [![coverage](http://codecov.io/github/BioJulia/BioAlignments.jl/coverage.svg?branch=master)](http://codecov.io/github/BioJulia/BioAlignments.jl?branch=master) |


## Contributing and Questions
## Contributing

We appreciate contributions from users including reporting bugs, fixing
issues, improving performance and adding new features.

Take a look at the [CONTRIBUTING](CONTRIBUTING.md) file provided with
this package for detailed contributor and maintainer guidelines.
every BioJulia package package for detailed contributor and maintainer
guidelines.


### Financial contributions

We also welcome financial contributions in full transparency on our
[open collective](https://opencollective.com/biojulia).
Anyone can file an expense. If the expense makes sense for the development
of the community, it will be "merged" in the ledger of our open collective by
the core contributors and the person who filed the expense will be reimbursed.


## Backers & Sponsors

Thank you to all our backers and sponsors!

Love our work and community? [Become a backer](https://opencollective.com/biojulia#backer).

[![backers](https://opencollective.com/biojulia/backers.svg?width=890)](https://opencollective.com/biojulia#backers)

Does your company use BioJulia? Help keep BioJulia feature rich and healthy by
[sponsoring the project](https://opencollective.com/biojulia#sponsor)
Your logo will show up here with a link to your website.

[![](https://opencollective.com/biojulia/sponsor/0/avatar.svg)](https://opencollective.com/biojulia/sponsor/0/website)
[![](https://opencollective.com/biojulia/sponsor/1/avatar.svg)](https://opencollective.com/biojulia/sponsor/1/website)
[![](https://opencollective.com/biojulia/sponsor/2/avatar.svg)](https://opencollective.com/biojulia/sponsor/2/website)
[![](https://opencollective.com/biojulia/sponsor/3/avatar.svg)](https://opencollective.com/biojulia/sponsor/3/website)
[![](https://opencollective.com/biojulia/sponsor/4/avatar.svg)](https://opencollective.com/biojulia/sponsor/4/website)
[![](https://opencollective.com/biojulia/sponsor/5/avatar.svg)](https://opencollective.com/biojulia/sponsor/5/website)
[![](https://opencollective.com/biojulia/sponsor/6/avatar.svg)](https://opencollective.com/biojulia/sponsor/6/website)
[![](https://opencollective.com/biojulia/sponsor/7/avatar.svg)](https://opencollective.com/biojulia/sponsor/7/website)
[![](https://opencollective.com/biojulia/sponsor/8/avatar.svg)](https://opencollective.com/biojulia/sponsor/8/website)
[![](https://opencollective.com/biojulia/sponsor/9/avatar.svg)](https://opencollective.com/biojulia/sponsor/9/website)


## Questions?

If you have a question about contributing or using this package, come
on over and chat to us on [Discord][discord-url], or you can try the
If you have a question about contributing or using BioJulia software, come
on over and chat to us on [Discord](https://discord.gg/z73YNFz), or you can try the
[Bio category of the Julia discourse site](https://discourse.julialang.org/c/domain/bio).

0 comments on commit 63b0b88

Please sign in to comment.