diff options
| author | Philipp Tanlak <philipp.tanlak@gmail.com> | 2023-11-13 22:36:15 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-13 22:36:15 +0100 |
| commit | 190056ee8d6a4eca61d92a79cc25aad645e69d4a (patch) | |
| tree | 423cb3dfb7ca92e4c1c48c1070f553bbadc4d890 /docs/getting-started | |
| parent | eae10426cd805ecc0a0459b61639e48e6cd913ad (diff) | |
Move docs to flyscrape.com (#11)
Diffstat (limited to 'docs/getting-started')
| -rw-r--r-- | docs/getting-started/installation.md | 45 | ||||
| -rw-r--r-- | docs/getting-started/running-flyscrape.md | 43 |
2 files changed, 0 insertions, 88 deletions
diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md deleted file mode 100644 index d10e99c..0000000 --- a/docs/getting-started/installation.md +++ /dev/null @@ -1,45 +0,0 @@ -# Installation - -Welcome to flyscrape! This section will guide you through the installation process, ensuring you have everything you need to start using this powerful web scraping tool. - -## Prerequisites - -Before installing flyscrape, make sure you have the following prerequisites: - -1. **Go Programming Language**: flyscrape is built with Go, so you need to have Go installed on your system. If you don't have it installed, you can download it from the [official Go website](https://golang.org/). - -## Installing flyscrape - -Once you have Go installed, you can proceed with installing flyscrape. Follow these simple steps: - -1. **Open a Terminal**: Launch your terminal or command prompt. - -2. **Install flyscrape**: Run the following command to install flyscrape using Go's package manager: - - ```bash - go install github.com/philippta/flyscrape/cmd/flyscrape@latest - ``` - - This command will download the latest version of flyscrape and install it on your system. - -3. **Verify Installation**: To confirm that flyscrape has been successfully installed, you can run the following command: - - ```bash - flyscrape - ``` - - If the installation was successful, this command will display the help text of flyscrape. - -## Updating flyscrape - -To keep your flyscrape installation up to date, you can use the following command: - -```bash -go get -u github.com/philippta/flyscrape/cmd/flyscrape@latest -``` - -This command will fetch and install the latest version of flyscrape from the GitHub repository. - -Congratulations! You've successfully installed flyscrape on your system. Now you're ready to dive into web scraping and start extracting data from websites with ease. - -Next, you can learn how to run flyscrape and start creating your scraping scripts by following the "Running flyscrape" section in the "Getting Started" category. diff --git a/docs/getting-started/running-flyscrape.md b/docs/getting-started/running-flyscrape.md deleted file mode 100644 index c042e4e..0000000 --- a/docs/getting-started/running-flyscrape.md +++ /dev/null @@ -1,43 +0,0 @@ -# Running flyscrape - -Once you've successfully installed flyscrape, you're ready to start using it to scrape data from websites. This section will guide you through the basic commands and steps to run flyscrape effectively. - -## Creating Your First Scraping Script - -Before you can run flyscrape, you'll need a scraping script to tell it what data to extract from a website. To create a new scraping script, you can use the `new` command followed by the script's filename. Here's an example: - -```bash -flyscrape new my_first_script.js -``` - -This command will generate a sample scraping script named `my_first_script.js` in the current directory. You can edit this script to customize it according to your scraping needs. - -## Running a Scraping Script - -To execute a scraping script, you can use the `run` command followed by the script's filename. For example: - -```bash -flyscrape run my_first_script.js -``` - -When you run this command, flyscrape will start retrieving and processing data from the website specified in your script. - -## Watching for Development - -During the development phase, you may want to make changes to your scraping script and see the results quickly. flyscrape provides a convenient way to do this using the `dev` command. It allows you to watch your scraping script for changes and automatically re-run it when you save your changes. - -Here's how to use the `dev` command: - -```bash -flyscrape dev my_first_script.js -``` - -With the development mode active, you can iterate on your scraping script, fine-tune your data extraction queries, and see the results in real-time. - -## Script Output - -After running a scraping script, flyscrape will generate structured data based on your script's logic. You can customize your script to specify what data you want to extract and how it should be formatted. - -Congratulations! You've learned how to run flyscrape and create your first scraping script. You can now start gathering data from websites and transforming it into structured information. - -Next, explore more advanced topics in the "Using flyscrape" section to refine your scraping skills and learn how to set up more complex scraping scenarios. |