From 41196bb16b1bbd7efd81d2785e0925ba9b3352d6 Mon Sep 17 00:00:00 2001
From: Andrew Lamb <andrew@nerdnetworks.org>
Date: Tue, 1 Feb 2022 06:23:32 -0500
Subject: [PATCH] Refresh readme / contributing guide

---
 parquet/CONTRIBUTING.md |  5 +++++
 parquet/README.md       | 30 +++---------------------------
 2 files changed, 8 insertions(+), 27 deletions(-)

diff --git a/parquet/CONTRIBUTING.md b/parquet/CONTRIBUTING.md
index 834b6af9d4ef..77e9f417e49a 100644
--- a/parquet/CONTRIBUTING.md
+++ b/parquet/CONTRIBUTING.md
@@ -59,3 +59,8 @@ Run `cargo bench` for benchmarks.
 
 To build documentation, run `cargo doc --no-deps`.
 To compile and view in the browser, run `cargo doc --no-deps --open`.
+
+## Update Supported Parquet Version
+
+To update Parquet format to a newer version, check if [parquet-format](https://github.com/sunchao/parquet-format-rs)
+version is available. Then simply update version of `parquet-format` crate in Cargo.toml.
diff --git a/parquet/README.md b/parquet/README.md
index 74e643133d39..ed8b5518b8f9 100644
--- a/parquet/README.md
+++ b/parquet/README.md
@@ -23,38 +23,12 @@
 
 This crate contains the official Native Rust implementation of [Apache Parquet](https://parquet.apache.org/), which is part of the [Apache Arrow](https://arrow.apache.org/) project.
 
-## Example
-
-Example usage of reading data:
-
-```rust
-use std::fs::File;
-use std::path::Path;
-use parquet::file::reader::{FileReader, SerializedFileReader};
-
-let file = File::open(&Path::new("/path/to/file")).unwrap();
-let reader = SerializedFileReader::new(file).unwrap();
-let mut iter = reader.get_row_iter(None).unwrap();
-while let Some(record) = iter.next() {
-    println!("{}", record);
-}
-```
-
-For an example of reading to Arrow arrays, please see [here](https://docs.rs/parquet/latest/parquet/arrow/index.html)
-
-See [crate documentation](https://docs.rs/parquet/latest/parquet/) for the full API.
+See [crate documentation](https://docs.rs/parquet/latest/parquet/) for examples and the full API.
 
 ## Rust Version Compatbility
 
 This crate is tested with the latest stable version of Rust. We do not currrently test against other, older versions of the Rust compiler.
 
-## Supported Parquet Version
-
-- Parquet-format 4.0.0
-
-To update Parquet format to a newer version, check if [parquet-format](https://github.com/sunchao/parquet-format-rs)
-version is available. Then simply update version of `parquet-format` crate in Cargo.toml.
-
 ## Features
 
 - [x] All encodings supported
@@ -63,11 +37,13 @@ version is available. Then simply update version of `parquet-format` crate in Ca
   - [x] Primitive column value readers
   - [x] Row record reader
   - [x] Arrow record reader
+  - [x] Async support (to Arrow)
 - [x] Statistics support
 - [x] Write support
   - [x] Primitive column value writers
   - [ ] Row record writer
   - [x] Arrow record writer
+  - [ ] Async support
 - [ ] Predicate pushdown
 - [x] Parquet format 4.0.0 support