forked from apache/pulsar
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README by removing broken links and adding instruction on how…
… to build (apache#589)
- Loading branch information
Showing
2 changed files
with
33 additions
and
19 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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 | ||
|
@@ -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 | ||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters