-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore: polish readme to fix dead links
Signed-off-by: lizhanhui <lizhanhui@gmail.com>
- Loading branch information
Showing
7 changed files
with
2 additions
and
47 deletions.
There are no files selected for viewing
This file was deleted.
Oops, something went wrong.
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 |
---|---|---|
@@ -1,23 +1,17 @@ | ||
# Elastic Stream | ||
|
||
[![Codecov](https://img.shields.io/codecov/c/gh/AutoMQ/elastic-stream/master)](https://app.codecov.io/gh/AutoMQ/elastic-stream) | ||
|
||
## Overview | ||
ElasticStream is an open-source, elastic streaming platform. ElasticStream is designed on top of cloud infra-structure, excelling itself in scalability, fault-tolerance, cost-effectiveness and security. | ||
|
||
![Overview](docs/images/elastic-stream-arc.png) | ||
|
||
|
||
## Getting Started | ||
If you are brand new to elastic stream, we recommend you checkout our [motivation and architecture](https://elastic-stream.automq.com/docs/category/architecture) first. In case you want to get the system up and run quick demos, please read the [quick-start guide](https://elastic-stream.automq.com/docs/quick-start). | ||
If you are brand new to elastic stream, we recommend you checkout our [motivation and architecture](docs/architecture) first. In case you want to get the system up and run quick demos, please read the [quick-start guide](docs/quick-start). | ||
|
||
## Documentation | ||
|
||
Various docs and guides are placed [here](https://elastic-stream.automq.com). | ||
Various docs and guides are placed [here](docs). | ||
|
||
## How to Contribute | ||
We welcome contribution of various types: documentation, bug reporting, feature request, and pull requests. Before proposing a major large-scale change, it is advised to discuss your proposal first. | ||
|
||
|
||
## License | ||
This project is licensed under the [Server Side Public License](https://spdx.org/licenses/SSPL-1.0.html) |
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 |
---|---|---|
@@ -1,7 +1,3 @@ | ||
--- | ||
draft: true | ||
--- | ||
|
||
# Table of Contents | ||
|
||
* [Quick Start](./quick-start.mdx) | ||
|
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.