From a043a4e8baa7043fe4a03eb8e50f2d82e164c137 Mon Sep 17 00:00:00 2001 From: Wendell Smith Date: Thu, 2 Apr 2015 18:36:57 -0400 Subject: [PATCH] Travis fix, README update, version bump --- .travis.yml | 2 -- Cargo.toml | 2 +- README.md | 18 ++++++++++++++++-- 3 files changed, 17 insertions(+), 5 deletions(-) diff --git a/.travis.yml b/.travis.yml index b120584..f673788 100644 --- a/.travis.yml +++ b/.travis.yml @@ -17,5 +17,3 @@ after_success: | sudo pip install ghp-import && ghp-import -n target/doc && git push -fq https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages - -language: lets us specify rust, which for now defaults to the latest nightly. \ No newline at end of file diff --git a/Cargo.toml b/Cargo.toml index 6323cf4..9bac9bb 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "primes" -version = "0.1.4" +version = "0.1.5" authors = ["Wendell Smith "] license="BSD-3-Clause" diff --git a/README.md b/README.md index 6db1b47..326c9d8 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,24 @@ primes [![Build Status](https://travis-ci.org/wackywendell/primes.svg)](https://travis-ci.org/wackywendell/primes) -[Full Documentation](http://www.rust-ci.org/wackywendell/primes/doc/primes/) +[Full Documentation](http://wackywendell.github.io/primes) A prime generator for Rust. This package is available on [crates.io](git@github.com:wackywendell/primes.git) as `primes`. -This package provides an iterator over `all` primes, generating them lazily as it goes: see `PrimeSet::iter()`. +This package provides an iterator over `all` primes, generating them lazily as it goes. + +The simplest usage is simply to create an `Iterator`: + +``` +use primes::PrimeSet; + +let mut pset = PrimeSet::new(); + +for (ix, n) in pset.iter().enumerate().take(10) { + println!("Prime {}: {}", ix, n); +} +``` + +For more examples, see [the full documentation](http://wackywendell.github.io/primes)! \ No newline at end of file