diff --git a/README.md b/README.md index ae69377..e6e8cd5 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,26 @@ -# PolyJuMP +# PolyJuMP.jl -| **Build Status** | -|:----------------:| -| [![Build Status][build-img]][build-url] | -| [![Codecov branch][codecov-img]][codecov-url] | +[![Build Status](https://github.com/jump-dev/PolyJuMP.jl/workflows/CI/badge.svg?branch=master)](https://github.com/jump-dev/PolyJuMP.jl/actions?query=workflow%3ACI) +[![codecov](https://codecov.io/gh/jump-dev/PolyJuMP.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/jump-dev/PolyJuMP.jl) -PolyJuMP is an extension to [JuMP](https://github.com/jump-dev/JuMP.jl) for formulating and solving polynomial optimization problems. These problems can then be solved using [Sum of Squares Programming](https://github.com/jump-dev/SumOfSquares.jl). +[PolyJuMP.jl](https://github.com/jump-dev/PolyJuMP.jl) is a [JuMP](https://github.com/jump-dev/JuMP.jl) +extension for formulating and solving polynomial optimization problems. -## Documentation +These problems can then be solved using [SumOfSquares.jl](https://github.com/jump-dev/SumOfSquares.jl). + +## License + +`PolyJuMP.jl` is licensed under the [MIT license](https://github.com/jump-dev/PolyJuMP.jl/blob/master/LICENSE.md). -- [**STABLE**][docs-stable-url] — **most recently tagged version of [SumOfSquares](https://github.com/jump-dev/SumOfSquares.jl)' documentation.** -- [**LATEST**][docs-latest-url] — *in-development version of [SumOfSquares](https://github.com/jump-dev/SumOfSquares.jl)' documentation.* +## Installation -[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg -[docs-latest-img]: https://img.shields.io/badge/docs-latest-blue.svg -[docs-stable-url]: https://jump.dev/SumOfSquares.jl/stable -[docs-latest-url]: https://jump.dev/SumOfSquares.jl/latest +Install `PolyJuMP` using `Pkg.add`: +```julia +import Pkg +Pkg.add("PolyJuMP") +``` + +## Documentation -[build-img]: https://github.com/jump-dev/PolyJuMP.jl/workflows/CI/badge.svg?branch=master -[build-url]: https://github.com/jump-dev/PolyJuMP.jl/actions?query=workflow%3ACI -[codecov-img]: http://codecov.io/github/jump-dev/PolyJuMP.jl/coverage.svg?branch=master -[codecov-url]: http://codecov.io/github/jump-dev/PolyJuMP.jl?branch=master +Documentation for `PolyJuMP.jl` is included in the +[documentation for SumOfSquares.jl](https://jump.dev/SumOfSquares.jl/stable).