Skip to content

Commit

Permalink
Updated README by removing broken links and adding instruction on how…
Browse files Browse the repository at this point in the history
… to build (apache#589)
  • Loading branch information
merlimat authored Jul 21, 2017
1 parent ee65abe commit 2ab766a
Show file tree
Hide file tree
Showing 2 changed files with 33 additions and 19 deletions.
43 changes: 32 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@
Pulsar is a distributed pub-sub messaging platform with a very
flexible messaging model and an intuitive client API.

[![Maven Central](https://maven-badges.herokuapp.com/maven-central/org.apache.pulsar/pulsar/badge.svg)](https://maven-badges.herokuapp.com/maven-central/org.apache.pulsar/pulsar)

https://pulsar.incubator.apache.org

## Main features
* Horizontally scalable (Millions of independent topics and millions
Expand All @@ -26,18 +25,40 @@ flexible messaging model and an intuitive client API.
* Transparent handling of partitioned topics
* Transparent batching of messages

## Documentation
## Build Pulsar

Requirements:
* Java JDK 1.8
* Maven

Compile and install:

```bash
$ mvn install -DskipTests
```

Start standalone Pulsar service:

```bash
$ bin/pulsar standalone
```

* [Getting Started](docs/GettingStarted.md)
* [Architecture](docs/Architecture.md)
* [Documentation Index](docs/Documentation.md)
* [Announcement post on Yahoo Eng Blog](https://yahooeng.tumblr.com/post/150078336821/open-sourcing-pulsar-pub-sub-messaging-at-scale)
Check https://pulsar.incubator.apache.org for documentation and examples.

## Contact
* [Pulsar-Dev](https://groups.google.com/d/forum/pulsar-dev) for
development discussions
* [Pulsar-Users](https://groups.google.com/d/forum/pulsar-users) for
users questions

##### Mailing lists

| Name | Scope | | | |
|:------------------------------------------------------------------------------|:--------------------------------|:----------------------------------------------------------------|:--------------------------------------------------------------------|:-----------------------------------------------------------------------------|
| [[email protected]](mailto:[email protected]) | User-related discussions | [Subscribe](mailto:[email protected]) | [Unsubscribe](mailto:[email protected]) | [Archives](http://mail-archives.apache.org/mod_mbox/incubator-pulsar-users/) |
| [[email protected]](mailto:[email protected]) | Development-related discussions | [Subscribe](mailto:[email protected]) | [Unsubscribe](mailto:[email protected]) | [Archives](http://mail-archives.apache.org/mod_mbox/incubator-pulsar-dev/) |

##### Slack

Pulsar slack channel at https://apache-pulsar.slack.com/

You can self-register at https://apache-pulsar.herokuapp.com/

## License

Expand Down
9 changes: 1 addition & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -493,7 +493,7 @@ flexible messaging model and an intuitive client API.</description>
<artifactId>aspectjweaver</artifactId>
<version>${aspectj.version}</version>
</dependency>

<dependency>
<groupId>com.ea.agentloader</groupId>
<artifactId>ea-agent-loader</artifactId>
Expand Down Expand Up @@ -610,13 +610,6 @@ flexible messaging model and an intuitive client API.</description>
<cc>JAVADOC_STYLE</cc>
</mapping>
</configuration>
<executions>
<execution>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
Expand Down

0 comments on commit 2ab766a

Please sign in to comment.