Skip to content

Commit 89a4c05

Browse files
authored
Readme cleanup (#112)
1 parent 63c4780 commit 89a4c05

File tree

5 files changed

+59
-432
lines changed

5 files changed

+59
-432
lines changed

README.md

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,21 @@
11
<p align="center">
22
<span">
3-
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg#gh-light-mode-only" alt="Parseable" width="600" height="110" />
4-
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png#gh-dark-mode-only" alt="Parseable" width="650"/>
3+
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo.svg#gh-light-mode-only" alt="Parseable" width="500" height="100" />
4+
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/logo-dark.png#gh-dark-mode-only" alt="Parseable" width="500" height="100" />
55
</a>
66
</p>
77

88
<p align="center">
9-
<img src="https://img.shields.io/website?down_message=red&up_color=green&up_message=online&url=https%3A%2F%2Fwww.parseable.io" alt="website status">
10-
<img src="https://img.shields.io/github/contributors/parseablehq/parseable" alt="contributors">
119
<img src="https://img.shields.io/github/commit-activity/m/parseablehq/parseable" alt="commits activity monthly">
12-
<a href="https://github.com/parseablehq/parseable/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/parseablehq/parseable" alt="Github stars"></a>
13-
<img src="https://img.shields.io/github/license/parseablehq/parseable" alt="License">
10+
<a href="https://launchpass.com/parseable" target="_blank"><img src="https://img.shields.io/badge/join%20slack-parseable-brightgreen.svg" alt="join slack"></a>
11+
<a href="https://github.com/parseablehq/parseable/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/parseablehq/parseable?style=social" alt="Github stars"></a>
1412
<a href="https://twitter.com/parseableio" target="_blank"><img src="https://img.shields.io/twitter/follow/parseableio" alt="Twitter"></a>
1513
</p>
1614

1715
<h4 align="center">
18-
<a href="https://demo.parseable.io" target="_blank">Live Demo</a> |
19-
<a href="https://www.parseable.io" target="_blank">Website</a> |
20-
<a href="https://www.postman.com/parseable/workspace/parseable/overview" target="_blank">API Workspace on Postman</a>
16+
<a href="https://www.parseable.io/docs/quick-start" target="_blank">Quick Start</a> |
17+
<a href="https://www.parseable.io/docs/introduction" target="_blank">Documentation</a> |
18+
<a href="https://demo.parseable.io" target="_blank">Live Demo</a>
2119
<br>
2220
</h4>
2321

@@ -36,55 +34,8 @@ Parseable is a log storage and observability platform for modern, cloud native w
3634
* Bring your own analytics platform for deeper analysis of log data.
3735
* Auto inferred schema.
3836

39-
<p align="center">
40-
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview.svg#gh-light-mode-only" alt="Parseable Overview" width="800" height="650" />
41-
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview-dark.svg#gh-dark-mode-only" alt="Parseable Overview" width="800" height="650" />
42-
</p>
43-
44-
## Live Demo
45-
46-
Try out Parseable server with our demo instance. Send log data to default log stream `frontend`
47-
48-
```sh
49-
curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/frontend' \
50-
--header 'X-P-META-meta1: value1' \
51-
--header 'X-P-TAG-tag1: value1' \
52-
--header 'Authorization: Basic cGFyc2VhYmxlOnBhcnNlYWJsZQ==' \
53-
--header 'Content-Type: application/json' \
54-
--data-raw '[
55-
{
56-
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
57-
"datetime": "24/Jun/2022:14:12:15 +0000",
58-
"host": "153.10.110.81",
59-
"user-identifier": "Mozilla/5.0 (Windows NT 6.1; Win64; x64; rv:64.0) Gecko/20100101 Firefox/64.0",
60-
"method": "PUT",
61-
"status": 500,
62-
"referrer": "http://www.google.com/"
63-
}
64-
]'
65-
```
66-
67-
Access the Parseable dashboard to verify the log data is present
68-
69-
<table>
70-
<tr>
71-
<td>URL</td>
72-
<td><a href="https://demo.parseable.io" target="_blank">https://demo.parseable.io</a></td>
73-
</tr>
74-
<tr>
75-
<td>Username</td>
76-
<td>parseable</td>
77-
</tr>
78-
<tr>
79-
<td>Password</td>
80-
<td>parseable</td>
81-
</tr>
82-
</table>
83-
84-
For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview).
85-
86-
: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.
8737
## Getting Started
38+
8839
### Docker
8940
Parseable docker image is available on [Docker hub](https://hub.docker.com/r/parseable/parseable).
9041

@@ -136,14 +87,63 @@ export P_USERNAME="parseable"
13687
export P_PASSWORD="parseable"
13788
```
13889

90+
## Architecture
91+
92+
<p align="center">
93+
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview.svg#gh-light-mode-only" alt="Parseable Overview" width="800" height="650" />
94+
<img src="https://raw.githubusercontent.com/parseablehq/.github/main/images/overview-dark.svg#gh-dark-mode-only" alt="Parseable Overview" width="800" height="650" />
95+
</p>
96+
97+
## Live Demo
98+
99+
Try out Parseable server with our demo instance. Send log data to default log stream `frontend`
100+
101+
```sh
102+
curl --location --request POST 'https://demo.parseable.io/api/v1/logstream/frontend' \
103+
--header 'X-P-META-meta1: value1' \
104+
--header 'X-P-TAG-tag1: value1' \
105+
--header 'Authorization: Basic cGFyc2VhYmxlOnBhcnNlYWJsZQ==' \
106+
--header 'Content-Type: application/json' \
107+
--data-raw '[
108+
{
109+
"id": "434a5f5e-2f5f-11ed-a261-0242ac120002",
110+
"datetime": "24/Jun/2022:14:12:15 +0000",
111+
"host": "153.10.110.81",
112+
"user-identifier": "Mozilla/5.0 Gecko/20100101 Firefox/64.0",
113+
"method": "PUT",
114+
"status": 500,
115+
"referrer": "http://www.google.com/"
116+
}
117+
]'
118+
```
119+
120+
Access the Parseable dashboard to verify the log data is present
121+
122+
<table>
123+
<tr>
124+
<td>URL</td>
125+
<td><a href="https://demo.parseable.io" target="_blank">https://demo.parseable.io</a></td>
126+
</tr>
127+
<tr>
128+
<td>Username</td>
129+
<td>parseable</td>
130+
</tr>
131+
<tr>
132+
<td>Password</td>
133+
<td>parseable</td>
134+
</tr>
135+
</table>
136+
137+
For complete Parseable API documentation, refer to [Parseable API workspace on Postman](https://www.postman.com/parseable/workspace/parseable/overview).
138+
139+
: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.
140+
139141
## Contributing
140142

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

143145
## License
144146

145-
Copyright (c) 2022 [Parseable, Inc.](https://parseable.io)
146-
147147
Licensed under the GNU Affero General Public License, Version 3 (the "License");
148148
you may not use this file except in compliance with the License.
149149
You may obtain a copy of the License at

tests/Dockerfile

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

tests/Readme.md

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

tests/main.sh

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

0 commit comments

Comments
 (0)