Skip to content

Reorg readme for readability #96

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Sep 8, 2022
Merged

Reorg readme for readability #96

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
947743f
more docs
nitisht Sep 8, 2022
223b12b
temp
nitisht Sep 8, 2022
2d973ad
temp
nitisht Sep 8, 2022
dce68e7
temp
nitisht Sep 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 6 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<p align="center">
<span">
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg#gh-light-mode-only" alt="Parseable" width="600" height="150" />
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg#gh-light-mode-only" alt="Parseable" width="600" height="110" />
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png#gh-dark-mode-only" alt="Parseable" width="650"/>
</a>
</p>
Expand All @@ -18,12 +18,10 @@
<a href="https://demo.parseable.io" target="_blank">Live Demo</a> |
<a href="https://www.parseable.io" target="_blank">Website</a> |
<a href="https://www.postman.com/parseable/workspace/parseable/overview" target="_blank">API Workspace on Postman</a>
<br>
</h4>

Parseable is a free and open source, log storage and observability platform.

Parseable ingests high volumes of log data from various sources (Fluent Bit, Logstash etc or directly from applications). It stores logs into highly compressed Parquet file format. With object storage as primary storage for Parseable, you get seamless scale and flexibility for ever growing log data.

Parseable is a log storage and observability platform for modern, cloud native workloads. Parseable is built for high volume log data from sources like Fluent Bit, Logstash etc or directly from applications.
## Why Parseable

* Developer first platform, designed for ease of use and flexibility.
Expand All @@ -43,8 +41,6 @@ Parseable ingests high volumes of log data from various sources (Fluent Bit, Log
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview-dark.svg#gh-dark-mode-only" alt="Parseable Overview" width="800" height="650" />
</p>

<h1></h1>

## Live Demo

Try out Parseable server with our demo instance. Send log data to default log stream `frontend`
Expand Down Expand Up @@ -87,12 +83,7 @@ Access the Parseable dashboard to verify the log data is present

For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview).

| :memo: | Parseable is in alpha stage and will evolve over time. There may be breaking changes between releases. Please give us your feedback in [Slack](https://launchpass.com/parseable), or [Issues](https://github.com/parseablehq/parseable/issues/new). |
|-|:-|

| :exclamation: | Please do not store any sensitive data on this server as the data is openly accessible. We'll delete the data on this server periodically. |
|-|:-|

:exclamation: Please do not store any sensitive data on this server as the data is openly accessible. We'll delete the data on this server periodically.
## Getting Started

Parseable binary is available on [Github releases](https://github.com/parseablehq/parseable/releases). Please download the latest release for your platform.
Expand All @@ -109,6 +100,8 @@ export P_S3_BUCKET="parseable"

By default Parseable uses a public bucket to store the data. Please change the object storage credentials to your own bucket, before using Parseable.

:memo: Parseable is in alpha stage and will evolve over time. There may be breaking changes between releases. Please give us your feedback in [Slack](https://launchpass.com/parseable), or [Issues](https://github.com/parseablehq/parseable/issues/new).

## Contributing

Refer to the contributing guide [here](https://www.parseable.io/docs/contributing).
Expand Down