Skip to content

Commit

Permalink
chore: -
Browse files Browse the repository at this point in the history
  • Loading branch information
enenumxela committed Apr 6, 2022
1 parent 70658d8 commit 596f7c9
Show file tree
Hide file tree
Showing 19 changed files with 914 additions and 627 deletions.
3 changes: 2 additions & 1 deletion .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
workflow_dispatch:

jobs:
build:
Expand All @@ -14,7 +15,7 @@ jobs:
name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.14
go-version: 1.17

-
name: Check out code
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
create:
tags:
- v*
workflow_dispatch:

jobs:
release:
Expand All @@ -14,7 +15,7 @@ jobs:
name: Set up Go
uses: actions/setup-go@v2
with:
go-version: 1.14
go-version: 1.17

-
name: "Check out code"
Expand Down
64 changes: 37 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,39 +2,25 @@

[![release](https://img.shields.io/github/release/signedsecurity/sigrawl3r?style=flat&color=0040ff)](https://github.com/signedsecurity/sigrawl3r/releases) [![maintenance](https://img.shields.io/badge/maintained%3F-yes-0040ff.svg)](https://github.com/signedsecurity/sigrawl3r) [![open issues](https://img.shields.io/github/issues-raw/signedsecurity/sigrawl3r.svg?style=flat&color=0040ff)](https://github.com/signedsecurity/sigrawl3r/issues?q=is:issue+is:open) [![closed issues](https://img.shields.io/github/issues-closed-raw/signedsecurity/sigrawl3r.svg?style=flat&color=0040ff)](https://github.com/signedsecurity/sigrawl3r/issues?q=is:issue+is:closed) [![license](https://img.shields.io/badge/license-MIT-gray.svg?colorB=0040FF)](https://github.com/signedsecurity/sigrawl3r/blob/master/LICENSE) [![twitter](https://img.shields.io/badge/twitter-@signedsecurity-0040ff.svg)](https://twitter.com/signedsecurity)

A fast web crawler.

## Resources

* [Installation](#installation)
* [From Binary](#from-binary)
* [From source](#from-source)
* [From github](#from-github)
* [Features](#features)
* [Usage](#usage)
* [Installation](#installation)
* [From Binary](#from-binary)
* [From source](#from-source)
* [From github](#from-github)
* [Contribution](#contribution)

## Features

## Installation

#### From Binary

You can download the pre-built binary for your platform from this repository's [releases](https://github.com/signedsecurity/sigrawl3r/releases/) page, extract, then move it to your `$PATH`and you're ready to go.

#### From Source

sigrawl3r requires **go1.14+** to install successfully. Run the following command to get the repo

```bash
GO111MODULE=on go get -u -v github.com/signedsecurity/sigrawl3r/cmd/sigrawl3r
```

#### From Github

```bash
git clone https://github.com/signedsecurity/sigrawl3r.git && \
cd sigrawl3r/cmd/sigrawl3r/ && \
go build . && \
mv sigrawl3r /usr/local/bin/ && \
sigrawl3r -h
```
* Parses sitemap for URLs.
* Parses robots.txt for URLs.
* Extracts URLs from documents *(including js, json, xml, csv, txt e.t.c)*.
* Supports javaScript rendering *(including Single Page Applications such as Angular, React, e.t.c)*.
* Supports customizable parallelism.

## Usage

Expand Down Expand Up @@ -66,6 +52,30 @@ OPTIONS:
-x comma separated list of proxies
```

## Installation

#### From Binary

You can download the pre-built binary for your platform from this repository's [releases](https://github.com/signedsecurity/sigrawl3r/releases/) page, extract, then move it to your `$PATH`and you're ready to go.

#### From Source

sigrawl3r requires **go1.14+** to install successfully. Run the following command to get the repo

```bash
GO111MODULE=on go get -u -v github.com/signedsecurity/sigrawl3r/cmd/sigrawl3r
```

#### From Github

```bash
git clone https://github.com/signedsecurity/sigrawl3r.git && \
cd sigrawl3r/cmd/sigrawl3r/ && \
go build . && \
mv sigrawl3r /usr/local/bin/ && \
sigrawl3r -h
```

## Contribution

[Issues](https://github.com/signedsecurity/sigrawl3r/issues) and [Pull Requests](https://github.com/signedsecurity/sigrawl3r/pulls) are welcome!
Loading

0 comments on commit 596f7c9

Please sign in to comment.