Skip to content
This repository has been archived by the owner on Oct 13, 2019. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
mishako authored Mar 22, 2019
1 parent c619c99 commit 2171aea
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

This is a temporary repository for initial discussions and development of the new version of [Rome](https://github.com/rometools/rome). It will be merged into the main repository once we're ready to ship an alpha version.


## Why exactly are we doing this?
See https://github.com/rometools/rome/issues/353 for the explanation and a rough plan.

Expand All @@ -20,3 +19,30 @@ See https://github.com/rometools/rome/issues/353 for the explanation and a rough

### Prototype
- [x] Initial suggestion ([#10](https://github.com/rometools/rome2/issues/10))

### Try it out

See [RomeTest.java](throwaway-prototype/core/src/test/java/com/rometools/rome/RomeTest.java) for general overview of the functionality implemented so far.

Install locally:
```
git clone [email protected]:rometools/rome2.git
cd rome2/throwaway-prototype
mvn install
```

Add the dependency to your project:
```
<dependency>
<groupId>com.rometools.rome2.prototype</groupId>
<artifactId>core</artifactId>
<version>0.0.1-SNAPSHOT</version>
</dependency>
```

Use it:
```
byte[] source = ...
Feed feed = Rome.minimal().read(source);
System.out.println(feed.getTitle());
```

0 comments on commit 2171aea

Please sign in to comment.