Skip to content

Fix typos, add usage example, clarify tests and contributing #343

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

Merged
kescobo merged 3 commits into from
Dec 4, 2025
Merged

Fix typos, add usage example, clarify tests and contributing #343

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
83ab7ca
Fix typos, add usage example, clarify tests and contributing
Bano733 Nov 28, 2025
845eeef
Update README.md
Bano733-code Dec 2, 2025
62d9004
Update README.md
Bano733-code Dec 2, 2025
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
28 changes: 26 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,18 @@ REPL. Press `]` to enter pkg mode, and enter the following:
```julia
add BioSequences
```
## Example
```julia
using BioSequences

# Create a DNA sequence
seq = DNASequence("ACGTACGT") # or dna"ACGTACGT"
println(seq)

# Get the reverse complement
revcomp = reverse_complement(seq)
println(revcomp)
```

If you are interested in the cutting edge of the development, please check out
the master branch to try new features before release.
Expand All @@ -31,14 +43,26 @@ BioSequences is tested against Julia `1.X` on Linux, OS X, and Windows.
[![](https://codecov.io/gh/BioJulia/BioSequences.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/BioJulia/BioSequences.jl)
[![Downstream](https://github.com/BioJulia/BioSequences.jl/actions/workflows/Downstream.yml/badge.svg)](https://github.com/BioJulia/BioSequences.jl/actions/workflows/Downstream.yml)

Run tests from the Julia REPL:

```julia
using Pkg
Pkg.test("BioSequences")
```
## Contributing

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

Take a look at the [contributing files](https://github.com/BioJulia/Contributing)
detailed contributor and maintainer guidelines, and code of conduct.
Take a look at the [contributing files](https://github.com/BioJulia/Contributing) for detailed contributor and maintainer guidelines, and code of conduct.

Steps to contribute:

1. Fork the repository
2. Clone your fork locally
3. Make your changes
4. Commit & push to your fork
5. Open a Pull Request


## Backers & Sponsors
Expand Down
Loading