This is an automated email from the ASF dual-hosted git repository.
vinoth pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-hudi.git
The following commit(s) were added to refs/heads/master by this push:
new ff68810 [DOCS] Update Hudi Readme (#1058)
ff68810 is described below
commit ff688107fa99742cccaa0a80075f58efb017ebab
Author: lamber-ken <[email protected]>
AuthorDate: Tue Dec 3 01:25:43 2019 +0800
[DOCS] Update Hudi Readme (#1058)
- Add build status
- Clean up layout
---
README.md | 28 +++++++++++++++++++---------
1 file changed, 19 insertions(+), 9 deletions(-)
diff --git a/README.md b/README.md
index 4f0d72d..c254548 100644
--- a/README.md
+++ b/README.md
@@ -15,11 +15,17 @@
limitations under the License.
-->
-# Hudi
+# Apache Hudi (Incubating)
Apache Hudi (Incubating) (pronounced Hoodie) stands for `Hadoop Upserts
Deletes and Incrementals`.
Hudi manages the storage of large analytical datasets on DFS (Cloud stores,
HDFS or any Hadoop FileSystem compatible storage).
-### Features
+<http://hudi.apache.org/>
+
+[](https://travis-ci.org/apache/incubator-hudi)
+[](https://www.apache.org/licenses/LICENSE-2.0.html)
+[](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22org.apache.hudi%22)
+
+## Features
* Upsert support with fast, pluggable indexing
* Atomically publish data with rollback support
* Snapshot isolation between writer & queries
@@ -29,16 +35,20 @@ Hudi manages the storage of large analytical datasets on
DFS (Cloud stores, HDFS
* Timeline metadata to track lineage
Hudi provides the ability to query via three types of views:
- * **Read Optimized View** - Provides excellent snapshot query performance via
purely columnar storage (e.g. [Parquet](https://parquet.apache.org/))
+ * **Read Optimized View** - Provides excellent snapshot query performance via
purely columnar storage (e.g. [Parquet](https://parquet.apache.org/)).
* **Incremental View** - Provides a change stream with records inserted or
updated after a point in time.
- * **Real-time View** - Provides snapshot queries on real-time data, using a
combination of columnar & row-based storage (e.g Parquet +
[Avro](http://avro.apache.org/docs/current/mr.html))
+ * **Real-time View** - Provides snapshot queries on real-time data, using a
combination of columnar & row-based storage (e.g
[Parquet](https://parquet.apache.org/) +
[Avro](http://avro.apache.org/docs/current/mr.html)).
Learn more about Hudi at [https://hudi.apache.org](https://hudi.apache.org)
-### Building Apache Hudi from source {#building-hudi}
+## Building Apache Hudi from source {#building-hudi}
+
+Prerequisites for building Apache Hudi:
-Hudi requires Java 8 to be installed on a *nix system. Check out
[code](https://github.com/apache/incubator-hudi) and
-normally build the maven project, from command line:
+* Unix-like system (like Linux, Mac OS X)
+* Java 8 (Java 9 or 10 may work)
+* Git
+* Maven
```
# Checkout code and build
@@ -46,6 +56,6 @@ git clone https://github.com/apache/incubator-hudi.git && cd
incubator-hudi
mvn clean package -DskipTests -DskipITs
```
-### Quickstart
+## Quickstart
-Try
[https://hudi.apache.org/quickstart.html](https://hudi.apache.org/quickstart.html)
to quickly explore Hudi's capabilities using spark-shell.
+Please visit
[https://hudi.apache.org/quickstart.html](https://hudi.apache.org/quickstart.html)
to quickly explore Hudi's capabilities using spark-shell.