Skip to content

Commit df48774

Browse files
JohnMcLearclaude
andcommitted
Rewrite README with consistent structure, install instructions, and 1MB limit
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 3c79758 commit df48774

1 file changed

Lines changed: 22 additions & 10 deletions

File tree

README.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,29 @@
1-
![Publish Status](https://github.com/ether/ep_post_data/workflows/Node.js%20Package/badge.svg) [![Backend Tests Status](https://github.com/ether/ep_post_data/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/ether/ep_post_data/actions/workflows/test-and-release.yml)
1+
# ep_post_data
22

3-
# Post data straight to a pad
3+
POST data directly into an Etherpad pad via HTTP.
4+
5+
## Install
46

5-
## Curl example
67
```
7-
curl -X POST -d @/tmp/xbmc.log http://10.0.0.215:9001/post
8+
pnpm run plugins i ep_post_data
89
```
910

10-
You can also use the 'x-pad-id' header to define the resulting pad name or it will be randomized. Ex:
11-
```
12-
$ curl -X POST -d @datafile.txt -H 'X-PAD-ID: test123' http://10.0.0.215/post
13-
Pad Created: http://10.0.0.215/p/test123
11+
## Usage
12+
13+
POST to `/post` to create or update a pad. Set the `X-PAD-ID` header to choose the pad name, otherwise a random ID is generated.
14+
15+
```bash
16+
# Create a pad with a random ID
17+
curl -X POST -d @datafile.txt http://localhost:9001/post
18+
19+
# Create or update a specific pad
20+
curl -X POST -d @datafile.txt -H 'X-PAD-ID: mypad' http://localhost:9001/post
1421
```
1522

16-
## Limitation
17-
Etherpad Limits imports to 100k Characters
23+
## Limits
24+
25+
Request body is capped at 1 MB.
26+
27+
## License
28+
29+
Apache-2.0

0 commit comments

Comments
 (0)