Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
bjesus authored Sep 2, 2024
1 parent 332cd4a commit 241286a
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,10 @@ curl https://news.ycombinator.com/
2. Run `go run github.com/bjesus/pipet/cmd/pipet@latest myfile.pipet`
3. See all of the latest hacker news in your terminal!

Want it as JSON? Run `go run github.com/bjesus/pipet/cmd/pipet@latest --json myfile.pipet`! Want to template it? See more below.
<details><summary>Get as JSON</summary>Add the `--json` flag to make Pipet, like `go run github.com/bjesus/pipet/cmd/pipet@latest --json myfile.pipet` or `pipet --json myfile.file`</details>
<details><summary>Render to a template</summary>Peek a boo!</details>
<details><summary>Use pipes</summary>Peek a boo!</details>
<details><summary>Monitor for changes</summary>Peek a boo!</details>

# Pipet files
Pipet files describe where and how to get the data you are interested in. They are normal text files containing one or more blocks, separated with an empty line. Line beginning with `//` are ignored and can be used for comments. Every block has at least 2 sections - the first line containing the URL and the tool we are using for scraping, and the following lines describing the selectors reaching the data we would like scrap. Some blocks can end with a special last line pointing to the "next page" selector - more on that later.
Expand Down

0 comments on commit 241286a

Please sign in to comment.