Skip to content

Commit 8763abb

Browse files
authored
Readme add links (#188)
Add links to specific docs and remove the syslog-ng docs. Syslog-ng docs are now available at https://www.parseable.io/docs/log-agents/syslog-ng
1 parent c32d4b8 commit 8763abb

File tree

2 files changed

+7
-176
lines changed

2 files changed

+7
-176
lines changed

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,13 @@
1616

1717
## Why Parseable?
1818

19-
As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We faced this issue first hand at our jobs, and we've seen several other large scale Kubernetes users relating to this gap.
19+
As SREs, DevOps deploy and manage more and more cloud native applications, there is a glaring gap in the ecosystem for a developer friendly, cloud native, event & log observability platform. We saw this issue manifest multiple times in several shapes and forms, across organizations.
2020

21-
Parseable started because of this _missing_ case. We intend to enrich the ecosystem with a developer friendly, cloud native, event & log observability platform.
21+
Our aim with Parseable is to provide a fully open source, developer friendly, kubernetes and cloud native, scalable, logging and observability platform.
2222
## How it works
2323

2424
Parseable exposes REST API to ingest and query log data. Under the hood, it uses Apache Arrow and Parquet to handle and compress high volume log data. All data is stored in S3 (or compatible systems). Parseable also has a bundled web console to visualize and query log data.
2525

26-
Parseable can be deployed in cloud and container based environments in minutes and can scale as the requirements grow.
27-
2826
#### Key differentiators
2927

3028
- Written in Rust. Low CPU & memory footprint, with low latency, high throughput.
@@ -34,7 +32,7 @@ Parseable can be deployed in cloud and container based environments in minutes a
3432

3533
## Installing
3634

37-
Docker is the quickest way to experience Parseable on your machine. Run the below command to deploy Parseable in demo mode.
35+
Run the below command to deploy Parseable in demo mode with Docker.
3836

3937
```sh
4038
mkdir -p /tmp/data
@@ -47,7 +45,7 @@ docker run \
4745

4846
Once this runs successfully, you'll see dashboard at [http://localhost:8000](http://localhost:8000). You can login to the dashboard with `parseable`, `parseable` as the credentials. Please make sure not to post any important data while in demo mode.
4947

50-
For non-demo and other installation options (Kubernetes, bare-metal), please refer to the [documentation](https://www.parseable.io/docs/category/installation).
48+
Prefer other platforms? Check out installation options (Kubernetes, bare-metal), in the [documentation](https://www.parseable.io/docs/category/installation).
5149

5250
#### Live demo
5351

@@ -56,7 +54,6 @@ Instead of installing locally, you can also try out Parseable on our [Demo insta
5654
## Usage
5755

5856
If you've already deployed Parseable using the above Docker command, use below commands to create stream and post event(s) to the stream. Make sure to replace `<stream-name>` with the name of the stream you want to create and post events (e.g. `my-stream`).
59-
6057
#### Create a stream
6158

6259
```sh
@@ -85,7 +82,9 @@ curl --location --request POST 'http://localhost:8000/api/v1/logstream/<stream-n
8582
]'
8683
```
8784

88-
For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
85+
- For complete Parseable API documentation, refer to [Parseable API Docs](https://www.parseable.io/docs/category/api).
86+
- To configure Parseable with popular logging agents, please refer to the [agent documentation](https://www.parseable.io/docs/category/log-agents).
87+
- To integrate Parseable with your applications directly, please refer to the [integration documentation](https://www.parseable.io/docs/category/application-integration).
8988

9089
## Support
9190

docs/syslog_ng_log_forwarding.md

Lines changed: 0 additions & 168 deletions
This file was deleted.

0 commit comments

Comments
 (0)