Skip to content

Commit

Permalink
Edit CONTRIBUTING and README for clarity.
Browse files Browse the repository at this point in the history
- Reworded the issue tracker description for brevity.
- Rearranged sections by order of importance.
- Markdown cleanup.
  • Loading branch information
motlin committed Jan 14, 2016
1 parent 4b972b6 commit e8448e2
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 23 deletions.
5 changes: 2 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,9 @@ If this is your first time contributing to an Eclipse Foundation project, you'll
- [Sign your commits](https://wiki.eclipse.org/Development_Resources/Contributing_via_Git#Signing_off_on_a_commit)

Issues
--------------
------

This project uses [GitHub issues](https://github.com/eclipse/eclipse-collections/issues) to track ongoing development and issues. Be sure to search for existing issues before you create another one. Remember
that contributions are always welcome!
Search the [issue tracker](https://github.com/eclipse/eclipse-collections/issues) for a relevant issue or create a new one.

Making changes
--------------
Expand Down
53 changes: 33 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
# Eclipse Collections
Eclipse Collections
===================

[![][travis img]][travis]
[![][maven img]][maven]
[![][license-epl img]][license-epl]
[![][license-edl img]][license-edl]

Eclipse Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API, additional types not found in the JDK like Bags, Multimaps and set of utility classes that work with any JDK compatible Collections, Arrays, Maps or Strings. The iteration protocol was inspired by the Smalltalk collection framework.
Eclipse Collections is a collections framework for Java. It has JDK-compatible List, Set and Map implementations with a rich API, additional types not found in the JDK like Bags, Multimaps, and set of utility classes that work with any JDK compatible Collections, Arrays, Maps, or Strings. The iteration protocol was inspired by the Smalltalk collection framework.

Quick Example
-------------

## Quick Example
Eclipse Collections puts iteration methods on the container types. Lambdas are simulated using anonymous inner classes. Here's a code example that demonstrates the usual style of programming with Eclipse Collections.

```java
Expand Down Expand Up @@ -40,7 +43,9 @@ Or, a method reference:
MutableList<String> sortedLastNames = people.collect(Person::getLastName).sortThis();
```

## Why Eclipse Collections?
Why Eclipse Collections?
------------------------

* Improves readability and reduces duplication of iteration code (enforces DRY/OAOO)
* Implements several, high-level iteration patterns (select, reject, collect, inject into, etc.) on "humane" container interfaces which are extensions of the JDK interfaces
* Provides a consistent mechanism for iterating over Collections, Arrays, Maps, and Strings
Expand All @@ -50,7 +55,25 @@ MutableList<String> sortedLastNames = people.collect(Person::getLastName).sortTh
* Adds new containers including Bag, Interval, Multimap, BiMap, and immutable versions of all types
* Has been under active development since 2005 and is a mature library

## Acquiring Eclipse Collections
License
-------

Eclipse Collections is open sourced under the Eclipse Public License v1.0 and the Eclipse Distribution License v1.0.

How to Contribute
-----------------

We welcome contributions!

We accept contributions via pull requests here in GitHub. Please see [How To Contribute](CONTRIBUTING.md) to get started.

Project Roadmap
---------------

https://github.com/eclipse/eclipse-collections/wiki/Roadmap

Acquiring Eclipse Collections
-----------------------------

### Maven
```xml
Expand Down Expand Up @@ -98,26 +121,16 @@ compile 'org.eclipse.collections:eclipse-collections-forkjoin:7.0.0'
<dependency org="org.eclipse.collections" name="eclipse-collections-forkjoin" rev="7.0.0"/>
```

## License
Eclipse Collections is open sourced under the Eclipse Public License v1.0 and the Eclipse Distribution License v1.0.

## How to Contribute
We welcome contributions to the Eclipse Collections project!!

The Eclipse Collections project accepts contributions via pull requests in this GitHub. Please see [How To Contribute](CONTRIBUTING.md) for more detail.
Additional information
----------------------

## Project Roadmap
* Project Roadmap: https://github.com/eclipse/eclipse-collections/wiki/Roadmap

## Links
* Project Website: http://www.eclipse.org/collections
* Eclipse PME: https://projects.eclipse.org/projects/technology.collections
* GitHub: https://github.com/eclipse/eclipse-collections
* Issues: https://github.com/eclipse/eclipse-collections/issues
* Mailing lists: https://dev.eclipse.org/mailman/listinfo/collections-dev
* Wiki: https://github.com/eclipse/eclipse-collections/wiki
* Forum: https://www.eclipse.org/forums/index.php?t=thread&frm_id=329
* StackOverflow: http://stackoverflow.com/questions/tagged/eclipse-collections
* Mailing lists: https://dev.eclipse.org/mailman/listinfo/collections-dev
* Eclipse PME: https://projects.eclipse.org/projects/technology.collections
* Forum: https://www.eclipse.org/forums/index.php?t=thread&frm_id=329

[travis]:https://travis-ci.org/eclipse/eclipse-collections
[travis img]:https://travis-ci.org/eclipse/eclipse-collections.svg?branch=master
Expand Down

0 comments on commit e8448e2

Please sign in to comment.