README.md in red-parquet-0.0.2 vs README.md in red-parquet-0.12.0
- old
+ new
@@ -1,56 +1,54 @@
-# README
+<!---
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
-## Name
+ http://www.apache.org/licenses/LICENSE-2.0
-Red Parquet
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
-## Description
+# Red Parquet - Apache Parquet Ruby
-Red Parquet is a Ruby bindings of Apache Parquet. Red Parquet is based on GObject Introspection.
+Red Parquet is the Ruby bindings of Apache Parquet. Red Parquet is based on GObject Introspection.
[Apache Parquet](https://parquet.apache.org/) is a columnar storage format.
[GObject Introspection](https://wiki.gnome.org/action/show/Projects/GObjectIntrospection) is a middleware for language bindings of C library. GObject Introspection can generate language bindings automatically at runtime.
-Red Parquet uses [Parquet GLib](https://github.com/red-data-tools/parquet-glib) and [gobject-introspection gem](https://rubygems.org/gems/gobject-introspection) to generate Ruby bindings of Apache Parquet.
+Red Parquet uses [Apache Parquet GLib](https://github.com/apache/arrow/tree/master/c_glib/parquet-glib) and [gobject-introspection gem](https://rubygems.org/gems/gobject-introspection) to generate Ruby bindings of Apache Parquet.
-Parquet GLib is a C wrapper for [Parquet C++](https://github.com/apache/parquet-cpp). GObject Introspection can't use Parquet C++ directly. Parquet GLib is a bridge between Parquet C++ and GObject Introspection.
+Apache Parquet GLib is a C wrapper for [Apache Parquet C++](https://github.com/apache/arrow/tree/master/cpp/parquet). GObject Introspection can't use Apache Parquet C++ directly. Apache Parquet GLib is a bridge between Apache Parquet C++ and GObject Introspection.
gobject-introspection gem is a Ruby bindings of GObject Introspection. Red Parquet uses GObject Introspection via gobject-introspection gem.
## Install
-Install Parquet GLib before install Red Parquet. Use [Apache Arrow packages](https://github.com/red-data-tools/arrow-packages) for installing Parquet GLib.
+Install Apache Parquet GLib before install Red Parquet. Use [packages.red-data-tools.org](https://github.com/red-data-tools/packages.red-data-tools.org) for installing Apache Parquet GLib.
-Install Red Parquet after you install Parquet GLib:
+Note that the Apache Parquet GLib packages are "unofficial". "Official" packages will be released in the future.
+Install Red Parquet after you install Apache Parquet GLib:
+
```text
% gem install red-parquet
```
## Usage
```ruby
require "parquet"
-# TODO
+table = Arrow::Table.load("/dev/shm/data.parquet")
+# Process data in table
+table.save("/dev/shm/data-processed.parquet")
```
-
-## Dependencies
-
-* [Apache Parquet C++](https://github.com/apache/parquet-cpp) with Apache Arrow support
-
-* [Parquet GLib](https://github.com/red-data-tools/parquet-glib)
-
-* [Red Arrow](https://rubygems.org/gems/red-arrow)
-
-## Authors
-
-* Kouhei Sutou \<kou@clear-code.com\>
-
-## License
-
-Apache License 2.0. See doc/text/apache-2.0.txt for details.
-
-(Kouhei Sutou has a right to change the license including contributed
-patches.)