Update code examples and bump minor

Author: creativcoder

CHANGELOG.md

@@ -6,10 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 # [Unreleased]
 
+## 0.2.0 - 2020-10-10
 
-# [0.1.0] - 2020-10-08
+### Changed
 
-## Added
+- Reader takes a reference to the schema.
+
+## 0.1.0 - 2020-10-08
+
+### Added
 
 Initial implementation of
 - avrow

README.md

@@ -81,7 +81,7 @@ Add avrow as a dependency to `Cargo.toml`:
 
 ```toml
 [dependencies]
-avrow = "0.1.0"
+avrow = "0.2.0"
 ```
 
 ## Examples:
@@ -129,7 +129,7 @@ fn main() -> Result<(), Error> {
         183, 148, 48, 236, 212, 250, 38, 208,
     ];
     // Create a Reader
-    let reader = Reader::with_schema(v.as_slice(), schema)?;
+    let reader = Reader::with_schema(v.as_slice(), &schema)?;
     for i in reader {
         dbg!(&i);
     }
@@ -191,7 +191,7 @@ fn main() -> Result<(), Error> {
     let buf = writer.into_inner()?;
 
     // read
-    let reader = Reader::with_schema(buf.as_slice(), schema)?;
+    let reader = Reader::with_schema(buf.as_slice(), &schema)?;
     for i in reader {
         let a: LongList = from_value(&i)?;
         dbg!(a);
@@ -271,7 +271,7 @@ fn main() -> Result<(), Error> {
     writer.write(rec)?;
 
     let avro_data = writer.into_inner()?;
-    let reader = crate::Reader::from(avro_data.as_slice())?;
+    let reader = crate::Reader::new(avro_data.as_slice())?;
     for value in reader {
         let mentors: RustMentors = from_value(&value)?;
         dbg!(mentors);

src/lib.rs

@@ -1,13 +1,14 @@
 //! Avrow is a pure Rust implementation of the [Apache Avro specification](https://avro.apache.org/docs/current/spec.html).
 //!
-//! For more details on the spec, head over to [FAQ](https://cwiki.apache.org/confluence/display/AVRO/FAQ)
+//! Pleaes refer to the [README](https://github.com/creativcoder/avrow/blob/main/README.md) for an overview.
+//! For more details on the spec, head over to the [FAQ](https://cwiki.apache.org/confluence/display/AVRO/FAQ).
 //!
 //! ## Using the library
 //!
 //! Add to your `Cargo.toml`:
 //!```toml
 //! [dependencies]
-//! avrow = "0.1"
+//! avrow = "0.2.0"
 //!```
 //! ### A hello world example of reading and writing avro data files
 

src/reader.rs

@@ -38,10 +38,10 @@ where
     R: Read,
 {
     /// Creates a Reader from an avro encoded readable buffer.
-    pub fn new(mut avro_source: R) -> Result<Self, AvrowErr> {
-        let header = Header::from_reader(&mut avro_source)?;
+    pub fn new(mut source: R) -> Result<Self, AvrowErr> {
+        let header = Header::from_reader(&mut source)?;
         Ok(Reader {
-            source: avro_source,
+            source,
             header,
             reader_schema: None,
             block_buffer: Cursor::new(vec![0u8; DEFAULT_FLUSH_INTERVAL]),