Skip to content

Commit

Permalink
fix: the broken link about the issue status (#1402)
Browse files Browse the repository at this point in the history
## Rationale
The link about the issue status is broken.

## Detailed Changes
Fix the broken link.

## Test Plan
Ensure that the rendered issue status works.
  • Loading branch information
ShiKaiWi authored Dec 25, 2023
1 parent ab96579 commit 4161f49
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
![License](https://img.shields.io/badge/license-Apache--2.0-green.svg)
[![CI](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml/badge.svg)](https://github.com/apache/incubator-horaedb/actions/workflows/ci.yml)
[![OpenIssue](https://img.shields.io/github/issues/incubator-horaedb/horaedb)](https://github.com/apache/incubator-horaedb/issues)
[![OpenIssue](https://img.shields.io/github/issues/apache/incubator-horaedb)](https://github.com/apache/incubator-horaedb/issues)
<!-- [![Docker](https://img.shields.io/docker/v/horaedb/horaedb-server?logo=docker)](https://hub.docker.com/r/horaedb/horaedb-server) TODO need to wait for first apache version release.-->

[中文](./README-CN.md)

HoraeDB is a high-performance, distributed, cloud native time-series database.

## Documentation

- [User Guide](https://apache.github.io/incubator-horaedb-docs)
- [Development Guide](https://apache.github.io/incubator-horaedb-docs/dev/compile_run.html)
- [Roadmap](https://apache.github.io/incubator-horaedb-docs/dev/roadmap.html)

## Quick Start

### Run with Docker
Run HoraeDB standalone Server.

Run HoraeDB standalone Server.

```
docker run -d --name horaedb-server \
-p 8831:8831 \
Expand All @@ -24,6 +28,7 @@ docker run -d --name horaedb-server \
```

Create Table.

```
curl --location --request POST 'http://127.0.0.1:5440/sql' \
-d '
Expand All @@ -39,6 +44,7 @@ ENGINE=Analytic
```

Write data with SQL.

```
curl --location --request POST 'http://127.0.0.1:5440/sql' \
-d '
Expand All @@ -48,6 +54,7 @@ INSERT INTO demo (t, name, value)
```

Read data with SQL.

```
curl --location --request POST 'http://127.0.0.1:5440/sql' \
-d '
Expand All @@ -56,19 +63,23 @@ SELECT * FROM `demo`
```

### Run from source code

See details [here](https://apache.github.io/incubator-horaedb-docs/dev/compile_run.html).

## Contributing

Any contribution is welcome!

Discuss at [dev mailing list](mailto:dev-subscribe@horaedb.apache.org) ([subscribe](mailto:dev-subscribe@horaedb.apache.org?subject=(send%20this%20email%20to%20subscribe)) / [unsubscribe](mailto:dev-unsubscribe@horaedb.apache.org?subject=(send%20this%20email%20to%20unsubscribe)) / [archives](https://lists.apache.org/list.html?dev@horaedb.apache.org))

Read our [Contributing Guide](CONTRIBUTING.md) and make your first contribution!

## Acknowledgment

When develop HoraeDB, we benefit a lot from several other open source projects, such as [influxdb_iox](https://github.com/influxdata/influxdb/tree/main/influxdb_iox), [tikv](https://github.com/tikv/tikv) etc, thanks for their awesome work.

In our production usage, we heavily use [OceanBase](https://github.com/oceanbase/oceanbase) as implementation of both WAL and ObjectStorage, and OceanBase team help us maintain stability of our cluster, thanks for their kindly support.

## License

HoraeDB is under [Apache License 2.0](./LICENSE).

0 comments on commit 4161f49

Please sign in to comment.