README refreshment

snowplow · Dec 23, 2017 · 67bf149 · 67bf149
1 parent 67e845e
commit 67bf149
Show file tree

Hide file tree

Showing 9 changed files with 44 additions and 40 deletions.
diff --git a/0-common/igluctl/README.md b/0-common/igluctl/README.md
@@ -1,6 +1,6 @@
 # Igluctl
 
-[ ![Build Status][travis-image] ][travis] [ ![License][license-image] ][license]
+[![Build Status][travis-image]][travis] [![License][license-image]][license]
 
 Igluctl is command-line tool, that enables you to perform the most common tasks with **[Iglu][iglu]** schema registries, i.e.:
 
@@ -9,17 +9,17 @@ Igluctl is command-line tool, that enables you to perform the most common tasks
 * Publish JSON Schemas stored locally to Iglu schema registries
 * Publish JSON Schemas (or any other files) stored locally to AWS S3
 
-For complete documenation on Igluctl please refer to the [technical documentation] [technical-documentation].
+For complete documenation on Igluctl please refer to the [technical documentation][technical-documentation].
 
 ## User Quickstart
 
 You can download igluctl archive from our Bintray, using following link:
 
 ```
-http://dl.bintray.com/snowplow/snowplow-generic/igluctl_0.2.0.zip
+http://dl.bintray.com/snowplow/snowplow-generic/igluctl_0.3.0.zip
 ```
 
-Before running it - make sure you have [Oracle JRE 7] [jre] installed.
+Before running it - make sure you have [Oracle JRE 8][jre] installed.
 
 ### Windows
 
@@ -28,7 +28,7 @@ After downloading and unzipping archive you'll find file `igluctl` which is sing
 To run it you can use following format (executable file should be in current directory):
 
 ```bash
-$ java -jar igluctl lint {{input}}
+$ java -jar igluctl lint $SCHEMAS_DIR
 ```
 
 Below and everywhere in documentation you'll find example commands without `java -jar` prefix, which is Windows-specific.
@@ -38,55 +38,47 @@ Below and everywhere in documentation you'll find example commands without `java
 You can extract and run archive using following commands:
 
 ```bash
-$ unzip -j igluctl_0.2.0.zip
-$ ./igluctl lint {{input}}
+$ unzip -j igluctl_0.3.0.zip
+$ ./igluctl lint $SCHEMAS_DIR
 ```
 
 ## CLI
 
 ### Generate DDL
 
 You can transform JSON Schema into Redshift (other storages are coming) DDL, using `igluctl static generate` command.
-This functionality was previously implemented as **[Schema Guru] [schema-guru]** (pre-0.7.0) `ddl` subcommand
+This functionality was previously implemented as **[Schema Guru][schema-guru]** (pre-0.7.0) `ddl` subcommand
 
 ```bash
-$ ./igluctl static generate {{input}}
+$ ./igluctl static generate $SCHEMAS_DIR
 ```
 
-`{{input}}` should be the path to the JSON Schemas stored locally that are to be validated.
+`$SCHEMAS_DIR` should be the path to the JSON Schemas stored locally that are to be validated.
 
 ### Publish JSON Schemas to a remote Iglu Schema Registry
 
 You can publish your JSON Schemas from local filesystem to Iglu Scala Registry using `igluctl static push` command.
 
 
 ```bash
-$ ./igluctl static push {{input}} {{registry_host}} {{apikey}}
+$ ./igluctl static push $SCHEMAS_DIR $IGLU_HOST $APIKEY
 ```
 
 If you are running an s3 backed Iglu Static Server Registry you can publish schemas as follows:
 
 ```
-$ ./igluctl static s3cp {{input}} {{bucketname}} --accessKeyId {{ACCESS_KEY_ID}} --secretAccessKey {{SECRET_ACCESS_KEY}} --region {{AWS_REGION}}
+$ ./igluctl static s3cp $SCHEMAS_DIR $S3BUCKET --accessKeyId $ACCESS_KEY_ID --secretAccessKey $SECRET_ACCESS_KEY --region $AWS_REGION
 ```
 
-### Copy JSON Schemas to AWS S3
-
-You also can copy your JSON Schemas (JSON Path files or any other files) to Amazon S3 storage using `igluctl static s3cp` command.
-
-```bash
-$ ./igluctl static s3cp {{input}} {{bucketname}} --accessKeyId {{ACCESS_KEY_ID}} --secretAccessKey {{SECRET_ACCESS_KEY}} --region {{AWS_REGION}}
-```
-
-Igluctl will closely follow [AWS CLI] [aws-cli] tools behavior while looking for credentials, which means you can omit `accessKeyId` and `secretKeyId` options
+Igluctl will closely follow [AWS CLI][aws-cli] tools behavior while looking for credentials, which means you can omit `accessKeyId` and `secretKeyId` options
 if you have AWS `default` profile or appropriate environment variables.
 
 ### Linting
 
 You can check your JSON Schema for vairous common mistakes using `igluctl lint` command.
 
 ```bash
-$ ./igluctl_0.2.0 lint {{input}}
+$ ./igluctl_0.3.0 lint $SCHEMAS_DIR
 ```
 
 This check will include JSON Syntax validation (`required` is not empty, `maximum` is integer etc)
@@ -95,7 +87,7 @@ and also "sanity check", which checks that particular JSON Schema can always val
 
 ## Copyright and License
 
-Igluctl is copyright 2016 Snowplow Analytics Ltd.
+Igluctl is copyright 2016-2017 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.

diff --git a/0-common/scala-core/README.md b/0-common/scala-core/README.md
@@ -1,4 +1,6 @@
-# Scala Iglu Core [![Build Status](https://travis-ci.org/snowplow/iglu.png)](https://travis-ci.org/snowplow/iglu)
+# Scala Iglu Core
+
+[![Release][release-image]][releases] [![License][license-image]][license]
 
 Core entities for working with Iglu in Scala.
 
@@ -23,7 +25,7 @@ guest> sbt compile
 
 ## Copyright and license
 
-Iglu Scala Core is copyright 2016 Snowplow Analytics Ltd.
+Iglu Scala Core is copyright 2016-2017 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.
@@ -35,8 +37,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 
-[snowplow-repo]: https://github.com/snowplow/snowplow
-[snowplow-website]: http://snowplowanalytics.com
+[license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
+[license]: http://www.apache.org/licenses/LICENSE-2.0
+
+[release-image]: http://img.shields.io/badge/release-0.2.0-blue.svg?style=flat
+[releases]: https://github.com/snowplow/iglu/releases
 
 [vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
 [virtualbox-install]: https://www.virtualbox.org/wiki/Downloads

diff --git a/0-common/schema-ddl/README.md b/0-common/schema-ddl/README.md
@@ -1,6 +1,6 @@
 # Schema DDL
 
-[![Build Status][travis-image]][travis]  [![Release][release-image]][releases] [![License][license-image]][license]
+[![Release][release-image]][releases] [![License][license-image]][license]
 
 Schema DDL is a set of Abstract Syntax Trees and generators for producing various DDL and Schema formats.
 It's tightly coupled with other tools from **[Snowplow Platform][snowplow]** like
@@ -38,7 +38,7 @@ but JSONPaths file always should have the same order of fields and thus we canno
 
 ## Copyright and License
 
-Schema DDL is copyright 2014-2016 Snowplow Analytics Ltd.
+Schema DDL is copyright 2015-2017 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.
@@ -50,15 +50,11 @@ See the License for the specific language governing permissions and
 limitations under the License.
 
 
-
-[travis]: https://travis-ci.org/snowplow/schema-ddl
-[travis-image]: https://travis-ci.org/snowplow/schema-ddl.png?branch=master
-
 [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat
 [license]: http://www.apache.org/licenses/LICENSE-2.0
 
-[release-image]: http://img.shields.io/badge/release-0.5.0-blue.svg?style=flat
-[releases]: https://github.com/snowplow/schema-ddl/releases
+[release-image]: http://img.shields.io/badge/release-0.6.0-blue.svg?style=flat
+[releases]: https://github.com/snowplow/iglu/releases
 
 [snowplow]: https://github.com/snowplow/snowplow
 [iglu]: https://github.com/snowplow/iglu

diff --git a/0-common/schema-ddl/src/test/Worksheet.sc b/0-common/schema-ddl/src/test/Worksheet.sc
@@ -0,0 +1,10 @@
+val pf = {
+  case "foo" =>
+    3
+  case "bar" =>
+    println(234)
+    65
+  case a =>
+    println("sdfsdfsdf")
+    32
+}
diff --git a/2-repositories/README.md b/2-repositories/README.md
@@ -13,6 +13,7 @@ We currently have two Iglu "repo" technologies available for deploying your Iglu
 | [Scala repo server][r3] | Remote       | A RESTful Iglu repository server written in Scala          | Beta             |
 
 <a name="iglu-central" />
+
 ## Iglu Central
 
 Iglu Central ([http://iglucentral.com][iglucentral-website]) is a public repository of JSON Schemas hosted by [Snowplow Analytics][snowplow-website].

diff --git a/2-repositories/jvm-embedded-repo/README.md b/2-repositories/jvm-embedded-repo/README.md
@@ -10,7 +10,7 @@ A JVM-embedded repo is an Iglu repository **embedded** inside a Java or Scala ap
 
 ## Copyright and license
 
-JVM-Embedded Repo is copyright 2014 Snowplow Analytics Ltd.
+JVM-Embedded Repo is copyright 2014-2017 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.

diff --git a/2-repositories/scala-repo-server/README.md b/2-repositories/scala-repo-server/README.md
@@ -10,7 +10,7 @@ A Scala-based repository server for Iglu, allowing users to publish, test and se
 
 ## Copyright and license
 
-Scala Repo Server is copyright 2014 Snowplow Analytics Ltd.
+Scala Repo Server is copyright 2014-2017 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.

diff --git a/2-repositories/static-registry/README.md b/2-repositories/static-registry/README.md
@@ -10,7 +10,7 @@ A static registry is simply an Iglu registry server structured as a static websi
 
 ## Copyright and license
 
-Iglu Static Registry is copyright 2014-2016 Snowplow Analytics Ltd.
+Iglu Static Registry is copyright 2014-2017 Snowplow Analytics Ltd.
 
 Licensed under the **[Apache License, Version 2.0][license]** (the "License");
 you may not use this software except in compliance with the License.

diff --git a/README.md b/README.md
@@ -4,7 +4,7 @@
 [ ![Release][release-image] ][releases]
 [ ![License][license-image] ][license]
 
-Iglu is a machine-readable, open-source schema repository for **[JSON Schema] [json-schema]** from the team at **[Snowplow Analytics] [snowplow-website]**. A schema repository (sometimes called a registry) is like npm or Maven or git, but holds data schemas instead of software or code.
+Iglu is a machine-readable, open-source schema repository for **[JSON Schema][json-schema]** from the team at **[Snowplow Analytics][snowplow-website]**. A schema repository (sometimes called a registry) is like npm or Maven or git, but holds data schemas instead of software or code.
 
 Iglu is used extensively in **[Snowplow][snowplow-repo]**. For a presentation on how we came to build Iglu, see **[this blog post][snowplow-schema-post]**.
 
@@ -47,7 +47,7 @@ limitations under the License.
 [travis-image]: https://travis-ci.org/snowplow/iglu.png?branch=master
 [travis]: http://travis-ci.org/snowplow/iglu
 
-[release-image]: https://img.shields.io/badge/release-7_Adrianople-orange.svg?style=flat
+[release-image]: https://img.shields.io/badge/release-7_Treskilling_Yellow-orange.svg?style=flat
 [releases]: https://github.com/snowplow/snowplow/releases
 
 [license-image]: http://img.shields.io/badge/license-Apache--2-blue.svg?style=flat