Skip to content

Commit 3ce89a0

Browse files
committed
updated readme
1 parent 4a4aff2 commit 3ce89a0

File tree

1 file changed

+57
-10
lines changed

1 file changed

+57
-10
lines changed

README.md

+57-10
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,68 @@ Thanks for using Cascading.
66

77
For project documentation and community support, visit: [cascading.org](http://cascading.org/)
88

9-
This distribution includes five Cascading jar files:
9+
To download a pre-built distribution, visit [http://www.cascading.org/downloads/](http://www.cascading.org/downloads/),
10+
or use Maven (described below).
1011

11-
* cascading-core-x.y.z.jar - all Cascading Core class files
12-
* cascading-xml-x.y.z.jar - all Cascading XML operations class files
13-
* cascading-local-x.y.z.jar - all Cascading Local mode class files
14-
* cascading-hadoop-x.y.z.jar - all Cascading Hadoop mode class files
15-
* cascading-platform-x.y.z.jar - all Cascading common platform tests and test utilities
12+
The distribution includes four Cascading jar files:
1613

17-
These class jars, along with source and javadoc jars, are all available via the [Conjars.org](http://conjars.org)
18-
Maven repository.
14+
* `cascading-core-x.y.z.jar` - all Cascading Core class files
15+
* `cascading-xml-x.y.z.jar` - all Cascading XML operations class files
16+
* `cascading-local-x.y.z.jar` - all Cascading Local mode class files
17+
* `cascading-hadoop-x.y.z.jar` - all Cascading Hadoop mode class files
18+
19+
These class jars, along with, tests, source and javadoc jars, are all available via the
20+
[Conjars.org](http://conjars.org) Maven repository.
1921

2022
Hadoop mode is where the Cascading application should run on a Hadoop cluster.
2123

2224
Local mode is where the Cascading application will run locally in memory without any Hadoop dependenices.
2325

24-
The Platform jar only includes tests common across all supported platforms.
26+
## Versioning
27+
28+
Cascading stable releases are always of the form `x.y.z`, where `z` is the current maintenance release.
29+
30+
The source and tags for all stable releases can be found here:
31+
[https://github.com/Cascading/cascading](https://github.com/Cascading/cascading)
32+
33+
WIP (work in progress) releases are fully tested builds of code not yet deemed fully stable. On every build by our
34+
continuous integration servers, the WIP build number is increased. Successful builds are then tagged and published.
35+
36+
The WIP releases are always of the form `x.y.z-wip-n`, where `x.y.z` will be the next stable release version the WIP
37+
releases are leading up to. `n` is the current successfully tested build.
38+
39+
The source, working branches, and tags for all WIP releases can be found here:
40+
[https://github.com/cwensel/cascading](https://github.com/cwensel/cascading)
41+
42+
When a WIP is deemed stable and ready for production use, it will be published as a `x.y.z` release.
43+
44+
## Using with Maven/Ivy
45+
46+
It is strongly recommended developers pull Cascading from our Maven compatible jar repository
47+
[Conjars.org](http://conjars.org).
48+
49+
You can find the latest public and wip (work in progress) releases here:
50+
51+
* http://conjars.org/cascading/cascading-core
52+
* http://conjars.org/cascading/cascading-local
53+
* http://conjars.org/cascading/cascading-hadoop
54+
* http://conjars.org/cascading/cascading-xml
55+
56+
When creating tests, make sure to add any of the relevant above dependencies to your "test" scope or equivalent
57+
configuration along with the `cascading-platform` dependency.
58+
59+
* http://conjars.org/cascading/cascading-platform
60+
61+
Note the `cascading-plaform` compile dependency has no classes, you must pull the tests dependency with the
62+
"tests" classifier.
63+
64+
See [http://www.cascading.org/downloads/#maven](http://www.cascading.org/downloads/#maven) for example Maven pom
65+
dependency settings.
66+
67+
Source and Javadoc artifacts (using the appropriate classifier) are also available through Conjars.
68+
69+
Note that `cascading-hadoop` has a "provided" dependency on the Hadoop jars so that it won't get sucked into any
70+
application packaging as a dependency, typically.
2571

2672
## Building:
2773

@@ -57,4 +103,5 @@ For example, your job jar would look like this (via: `jar -t your.jar`)
57103
/lib/<cascading third-party jar files>
58104
```
59105

60-
Hadoop will unpack the jar locally and remotely (in the cluster) and add any libraries in `lib` to the classpath. This is a feature specific to Hadoop.
106+
Hadoop will unpack the jar locally and remotely (in the cluster) and add any libraries in `lib` to the classpath. This
107+
is a feature specific to Hadoop.

0 commit comments

Comments
 (0)