Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
DanielSchuette committed Aug 26, 2018
1 parent ea67149 commit b1cca91
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
# CloningPrimer

![GitHub (pre-)release](https://img.shields.io/badge/release-v0.0.2-green.svg) [![GoDoc](https://godoc.org/github.com/DanielSchuette/cloningPrimer?status.svg)](https://godoc.org/github.com/DanielSchuette/cloningPrimer) ![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg) [![Build Status](https://travis-ci.org/DanielSchuette/cloningPrimer.svg?branch=master)](https://travis-ci.org/DanielSchuette/cloningPrimer) [![codecov](https://codecov.io/gh/DanielSchuette/cloningPrimer/branch/master/graph/badge.svg)](https://codecov.io/gh/DanielSchuette/cloningPrimer)
![GitHub (pre-)release](https://img.shields.io/badge/release-v0.0.3-green.svg) [![GoDoc](https://godoc.org/github.com/DanielSchuette/cloningPrimer?status.svg)](https://godoc.org/github.com/DanielSchuette/cloningPrimer) ![Packagist](https://img.shields.io/packagist/l/doctrine/orm.svg) [![Build Status](https://travis-ci.org/DanielSchuette/cloningPrimer.svg?branch=master)](https://travis-ci.org/DanielSchuette/cloningPrimer) [![codecov](https://codecov.io/gh/DanielSchuette/cloningPrimer/branch/master/graph/badge.svg)](https://codecov.io/gh/DanielSchuette/cloningPrimer)

## <a name="about"></a> About

Cloning Primer is a software tool that facilitates the design of primer pairs for gene cloning. Given a certain nucleotide sequence and a set of parameters (see [Documentation](#documentation)), it returns forward and reverse primers as well as useful statistics like GC content, the probability of the primer pair to form dimers, and much more.

The software is accessible via a [web application](http://www.cloningprimer.com), but it is recommended to download the command line application ([CLI](./bin)) to enable offline use. Also, an API (written in Go) is available through this GitHub repository. Cloning Primer is under active development, so source code, web interface, API, and CLI might change in the future!

A working version of Cloning Primer is currently available as a pre-release version v0.0.2. Please review the [documentation section](#documentation) of this README file for more information about available functionality.
A working version of Cloning Primer is currently available as a pre-release version v0.0.3. Please review the [documentation section](#documentation) of this README file for more information about available functionality.




Expand Down Expand Up @@ -38,6 +39,7 @@ CLI binaries can be downloaded from [./bin](./bin) in this repository.




## <a name="documentation"></a> Documentation

### <a name="api"></a> Application Programming Interface (API)
Expand Down Expand Up @@ -83,16 +85,19 @@ func main() {
}
```


### <a name="cli"></a> Command Line Interface (CLI)

Documentation is coming soon.



### <a name="web_app"></a> Web Application

Documentation is coming soon.



## <a name="license"></a> License

This software is licensed under the MIT license, see *[LICENSE](./LICENSE.txt)* for more information.
Expand All @@ -111,3 +116,4 @@ This software is licensed under the MIT license, see *[LICENSE](./LICENSE.txt)*




0 comments on commit b1cca91

Please sign in to comment.