cmathiesen commented on a change in pull request #678: Add Java code examples 
and update site docs
URL: https://github.com/apache/incubator-iceberg/pull/678#discussion_r362402891
 
 

 ##########
 File path: examples/README.md
 ##########
 @@ -0,0 +1,182 @@
+# Iceberg Java API Examples (with Spark)
+
+## About
+Welcome! :smile:
+
+If you've stumbled across this module, hopefully you're looking for some 
guidance on how to get started with the [Apache 
Iceberg](https://iceberg.apache.org/) table format. This set of classes 
collects code examples of how to use the Iceberg Java API with Spark, along 
with some extra detail here in the README.
+
+The examples are structured as JUnit tests that you can download and run 
locally if you want to mess around with Iceberg yourself. 
+
+## Running Iceberg yourself
+If you'd like to try out Iceberg in your own project, you can use the 
`spark-iceberg-runtime` dependency:
 
 Review comment:
   Yep, this assumes the use of Maven. I think adding a new page for how to 
include Iceberg in different types of projects sounds like a good idea! I'll 
get a page ready to add to this PR :) I'm thinking the page should go under the 
User docs tab? 

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
[email protected]


With regards,
Apache Git Services

---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]

Reply via email to