prep for v0.1.0 release

Circuitscape · Aug 1, 2019 · 4f10bdd · 4f10bdd · vlandau · Aug 1, 2019
1 parent 48a83ad
commit 4f10bdd
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 9 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -4,12 +4,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Unreleased
-### Added
+## [Unreleased]
+### Adding
+- Option to do climate-based connectivity
+
+## v0.1.0
 - Omniscape algorithm with parallel processing
 - method for block artifact correction
-- error and bug fixes
 - option to use resistance surface to assign source weights
-### Adding
 
 [Unreleased]: https://github.com/circuitscape/Omniscape.jl/compare/v0.1.0...master
diff --git a/README.md b/README.md
@@ -2,13 +2,13 @@
 
 | **Documentation**  | **Build Status**| **Changelog**|
 |:-----------------------------------------------------:|:------------------------------------:|:-----------:|
-| [![docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://Circuitscape.github.io/Omniscape.jl/stable) [![docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://Circuitscape.github.io/Omniscape.jl/dev) | [![Build Status](https://travis-ci.org/Circuitscape/Omniscape.jl.svg?branch=master)](https://travis-ci.org/Circuitscape/Omniscape.jl) [![codecov](https://codecov.io/gh/Circuitscape/Omniscape.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Circuitscape/Omniscape.jl) [![Coverage Status](https://coveralls.io/repos/github/Circuitscape/Omniscape.jl/badge.svg?)](https://coveralls.io/github/Circuitscape/Omniscape.jl?branch=master)| [![news](https://img.shields.io/badge/version-unreleased-orange.svg)](https://github.com/Circuitscape/Omniscape.jl/blob/master/NEWS.md#news--changelog)
+| [![docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://Circuitscape.github.io/Omniscape.jl/stable) [![docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://Circuitscape.github.io/Omniscape.jl/dev) | [![Build Status](https://travis-ci.org/Circuitscape/Omniscape.jl.svg?branch=master)](https://travis-ci.org/Circuitscape/Omniscape.jl) [![codecov](https://codecov.io/gh/Circuitscape/Omniscape.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/Circuitscape/Omniscape.jl) [![Coverage Status](https://coveralls.io/repos/github/Circuitscape/Omniscape.jl/badge.svg?)](https://coveralls.io/github/Circuitscape/Omniscape.jl?branch=master)| [![news](https://img.shields.io/badge/version-v0.1.0-orange.svg)](https://github.com/Circuitscape/Omniscape.jl/blob/master/NEWS.md#news--changelog)
 
 Omniscape.jl is a Julia package that  provides an open-source, updated version of [Omniscape](https://conservationgateway.org/ConservationByGeography/NorthAmerica/UnitedStates/oregon/science/Documents/McRae_et_al_2016_PNW_CNS_Connectivity.pdf) with improved reliability and speed. Visit https://circuitscape.github.io/Omniscape.jl/stable for documentation.
 
 ## Installation
 Enter the following into a Julia terminal to install Omniscape.jl.
 ```julia
-julia> using Pkg; Pkg.add(PackageSpec(url = "https://github.com/Circuitscape/Omniscape.jl"))
+using Pkg; Pkg.add(PackageSpec(url = "https://github.com/Circuitscape/Omniscape.jl", rev = "v0.1.0"))
 
 ```
diff --git a/docs/src/usage.md b/docs/src/usage.md
@@ -2,11 +2,11 @@
 
 ## Running Omniscape
 
-To use Omniscape, simply run the following code after Omniscape.jl has be installed.
+To use Omniscape, simply run the following Julia code after Omniscape.jl has been installed.
 
 ```julia
-julia> using Omniscape
-julia> run_omniscape("path/to/config/file.ini")
+using Omniscape
+run_omniscape("path/to/config/file.ini")
 ```
 
 file.ini is a file specifying input data paths and options for Omniscape. See [this link](https://github.com/Circuitscape/Omniscape.jl/blob/master/test/input/config.ini) for an example `.ini` file. The arguments specified in the .ini file are described in detail below.