Crates.io release 0.0.1

Author: michaelsproul

.travis.yml

@@ -0,0 +1,8 @@
+language: rust
+os:
+  - linux
+script:
+  - cargo test --verbose
+  - cargo doc --no-deps
+after_success:
+  - test $TRAVIS_PULL_REQUEST == "false" && test $TRAVIS_BRANCH == "master" && bash upload-docs.sh

Cargo.toml

@@ -2,8 +2,17 @@
 
 name = "radix_trie"
 version = "0.0.1"
+description = "Generic radix trie data-structure."
+
+license = "MIT"
+license-file = "LICENSE"
 authors = ["Michael Sproul <[email protected]>"]
 
-[dependencies.nibble_vec]
+repository = "https://github.com/michaelsproul/rust_radix_trie"
+documentation = "https://michaelsproul.github.io/rust_radix_trie/"
+
+keywords = ["trie", "patricia", "collection", "generic", "prefix"]
+
+[dependencies]
 
-git = "https://github.com/michaelsproul/rust_nibble_vec.git"
+nibble_vec = "*"

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Michael Sproul
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

README.md

@@ -1,6 +1,8 @@
 Rust Radix Trie
 ====
 
+[![Build Status](https://travis-ci.org/michaelsproul/rust_radix_trie.svg)](https://travis-ci.org/michaelsproul/rust_radix_trie)
+
 This is a [Radix Trie][radix-wiki] implementation in Rust, building on the lessons learnt from
 `TrieMap` and [Sequence Trie][seq-trie].
 
@@ -10,11 +12,28 @@ This is a [Radix Trie][radix-wiki] implementation in Rust, building on the lesso
 * Key Generic. Any type that can be serialised as a vector of bytes can be used as a key.
 * Safe. No unsafe code (yet).
 
+# Usage
+
+Available on Crates.io as `radix_trie`.
+
+```toml
+[dependencies]
+radix_trie = "*"
+```
+
+# Documentation
+
+https://michaelsproul.github.io/rust_radix_trie/
+
 # To Do
 
-* Implement the Entry API.
 * Add Trie-specific methods for prefixes, successors, etc.
+* Implement the Entry API.
 * Add iterators.
 
 [radix-wiki]: http://en.wikipedia.org/wiki/Radix_tree
 [seq-trie]: https://github.com/michaelsproul/rust-sequence-trie
+
+# License
+
+MIT License. Copyright (c) Michael Sproul 2015.

upload-docs.sh

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+rev=$(git rev-parse --short HEAD)
+
+set -e
+
+cd target/doc
+
+# Add a page to redirect to the main crate.
+echo '<meta http-equiv="refresh" content="0; url=radix_trie/index.html">' > index.html
+
+git init
+git config user.name "Michael Sproul"
+git config user.email "[email protected]"
+
+git remote add upstream "https://$GH_TOKEN@github.com/michaelsproul/rust_radix_trie.git"
+git fetch upstream && git reset upstream/gh-pages
+
+git add -A .
+git commit -m "Rebuild pages at ${rev}."
+git push -q upstream HEAD:gh-pages