Prep 0.2.0 release

jpeddicord · May 14, 2018 · 9ba1249 · 9ba1249
1 parent a8221d4
commit 9ba1249
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## Unreleased
 
+Nothing yet. Planned: a requirement on Rust 1.26.
+
+## [0.2.0] - 2018-05-13
+
 ### Added
 
 - Full documentation for the public API.
@@ -19,6 +23,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Many performance improvements. `analyze` is now able to run in 3-5 ms on commodity hardware!
 - Text storage and normalization improvements.
 - Duplicate SPDX entries are now stored as aliases.
+- SPDX definitions have been updated.
+
+## Removed
+
+- The "diff" option is now only available if compiled with the "diagnostics" feature (off by default). This was intended for debugging and had no practical use in the binary.
+
+## Fixed
+
+- Resolved a potential panic for short/empty license files (a divide-by-zero was involved).
 
 ## [0.1.0] - 2018-01-31
 

diff --git a/Cargo.lock b/Cargo.lock
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "askalono"
-version = "0.2.0-beta.1"
+version = "0.2.0"
 description = "a library to detect the contents of license files"
 license = "Apache-2.0"
 repository = "https://github.com/amzn/askalono"

diff --git a/README.md b/README.md
@@ -4,7 +4,6 @@ askalono is a library and command-line tool to help detect license texts. It's d
 
 [![releases](https://img.shields.io/github/release-date-pre/amzn/askalono.svg)](https://github.com/amzn/askalono/releases)
 [![askalono crate](https://img.shields.io/crates/v/askalono.svg)](https://crates.io/crates/askalono)
-[![Gitter chat](https://img.shields.io/gitter/room/amzn/askalono.svg)](https://gitter.im/amzn/askalono)
 
 ## Notice
 
@@ -20,7 +19,7 @@ This software is in the early stages of its lifecycle. While its goals are to be
 
 **NOTE:** This is not currently `cargo install`-able from crates.io, but when it is you'll find it under `askalono-cli`.
 
-Pre-built binaries are available on the [Releases section](https://github.com/amzn/askalono/releases) on GitHub.
+Pre-built binaries are available on the [Releases section](https://github.com/amzn/askalono/releases) on GitHub. Rust developers may also grab a copy by running `cargo install askalono-cli`.
 
 Basic usage:
 
@@ -30,11 +29,9 @@ where `<filename>` is a file (not folder) containing license text to analyze. In
 
 ### As a library
 
-**Note:** This API is still unstable (and relatively undocumented). Semantic versioning will be respected, but anticipate significant changes throughout development.
-
 At the moment, `Store` and `LicenseContent` are exposed for usage. These have a relatively sane API, if unergonmic. Expect improvements in usage and documentation here.
 
-The best way to get an idea of how to use askalono as a library in its early state is to look at the [example](./examples/basic.rs).
+The best way to get an idea of how to use askalono as a library in its early state is to look at the [example](./examples/basic.rs). As of 0.2.0, decent documentation is available via docs.rs, and if the maintainer remembers to, they will add a link here once that's generated. (hint hint)
 
 ## Details
 
@@ -61,9 +58,9 @@ It means "shallot" in Esperanto. You could try to derive a hidden meaning from i
 
 ### How is this different from other solutions?
 
-There are several other excellent projects in this space, including [licensee](https://github.com/benbalter/licensee) and [LiD](https://source.codeaurora.org/external/qostg/lid/). These projects attempt to get a larger picture of a project's licensing, and can look at other sources of metadata to try to find answers. Both of these inspired the creation of askalono, first as a curiosity, then as a serious project.
+There are several other excellent projects in this space, including [licensee](https://github.com/benbalter/licensee), [LiD](https://source.codeaurora.org/external/qostg/lid/), and [ScanCode](https://github.com/nexB/scancode-toolkit). These projects attempt to get a larger picture of a project's licensing, and can look at other sources of metadata to try to find answers. Both of these inspired the creation of askalono, first as a curiosity, then as a serious project.
 
-askalono focuses on the problem of matching text itself -- it's often the piece that is difficult to optimize for speed and accuracy. askalono could be seen as a piece of plumbing in a larger system.
+askalono focuses on the problem of matching text itself -- it's often the piece that is difficult to optimize for speed and accuracy. askalono could be seen as a piece of plumbing in a larger system. The askalono command line application includes other goodies, such as a directory crawler, but these are largely for quick once-off use before diving in with more systematic solutions. (If you're looking for such a solution, take a look at the projects I just mentioned!)
 
 ### Where do the licenses come from?
 

diff --git a/cli/Cargo.toml b/cli/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "askalono-cli"
-version = "0.2.0-beta.1"
+version = "0.2.0"
 description = "a tool to detect the contents of license files"
 license = "Apache-2.0"
 repository = "https://github.com/amzn/askalono"
@@ -14,7 +14,7 @@ include = [
 ]
 
 [dependencies]
-askalono = { version = "0.2.0-beta.1", path = "../" }
+askalono = { version = "0.2.0", path = "../" }
 env_logger = "0.5.5"
 failure = "0.1.1"
 ignore = "0.4.1"

diff --git a/cli/src/util.rs b/cli/src/util.rs
@@ -34,6 +34,7 @@ pub fn load_store(cache_filename: &Path) -> Result<Store, Error> {
     Ok(store)
 }
 
+#[allow(unused_variables)]
 pub fn diff_result(license: &TextData, other: &TextData) {
     #[cfg(feature = "diagnostics")]
     {