summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPhilipp Tanlak <philipp.tanlak@gmail.com>2023-10-15 18:52:15 +0200
committerPhilipp Tanlak <philipp.tanlak@gmail.com>2023-10-15 18:52:15 +0200
commit21c3539e183102c4c861e0eb3d2e5044336f57b2 (patch)
tree2bdd5abb13d200dc34525f8e55ea534ccbe47231
parenta8316d6e84cef6499427257a5cf1b83d428afe63 (diff)
Reword flyscrape description
-rw-r--r--README.md18
-rw-r--r--cmd/flyscrape/main.go2
2 files changed, 13 insertions, 7 deletions
diff --git a/README.md b/README.md
index 4147d94..7d9e249 100644
--- a/README.md
+++ b/README.md
@@ -13,7 +13,7 @@
<br />
<p align="center">
-<b>flyscrape</b> is an expressive and elegant web scraper, combining the speed of Go with the <br/> flexibility of JavaScript. — Focus on data extraction rather than request juggling.
+<b>flyscrape</b> is a standalone and scriptable web scraper, combining the speed of Go with the flexibility of JavaScript. — Focus on data extraction rather than request juggling.
</p>
<br />
@@ -74,11 +74,18 @@ $ flyscrape run hackernews.js
## Installation
-To install **flyscrape**, follow these simple steps:
+### Pre-compiled binary
+
+`flyscrape` is available via for MacOS, Linux and Window as a downloadable binary from the [releases page](https://github.com/philippta/flyscrape/releases).
+
+### Compile from source
+
+To compile flyscrape from source, follow these steps:
+
1. Install Go: Make sure you have Go installed on your system. If not, you can download it from [https://golang.org/](https://golang.org/).
-2. Install **flyscrape**: Open a terminal and run the following command:
+2. Install flyscrape: Open a terminal and run the following command:
```bash
go install github.com/philippta/flyscrape/cmd/flyscrape@latest
@@ -87,8 +94,7 @@ To install **flyscrape**, follow these simple steps:
## Usage
```
-$ flyscrape
-flyscrape is an elegant scraping tool for efficiently extracting data from websites.
+flyscrape is a standalone and scriptable web scraper for efficiently extracting data from websites.
Usage:
@@ -128,7 +134,7 @@ flyscrape run example.js
## Configuration
-Below is an example scraping script that showcases the capabilities of **flyscrape**:
+Below is an example scraping script that showcases the capabilities of flyscrape:
```javascript
export const config = {
diff --git a/cmd/flyscrape/main.go b/cmd/flyscrape/main.go
index 81d0e2b..4450cd7 100644
--- a/cmd/flyscrape/main.go
+++ b/cmd/flyscrape/main.go
@@ -60,7 +60,7 @@ func (m *Main) Run(args []string) error {
func (m *Main) Usage() {
fmt.Println(`
-flyscrape is an elegant scraping tool for efficiently extracting data from websites.
+flyscrape is a standalone and scriptable web scraper for efficiently extracting data from websites.
Usage: