Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Created README/Documentation for get-title #13

Merged
merged 1 commit into from
Jul 22, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions get-title/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# Get-title

Takes a list of urls and prints their titles

Tomnomnom's get-title rewritten in Rust :crab: :rocket:!

## Quick links

[# Installation](#Installation) <br>
[# Usage](#Usage) <br>

## Installation

Run the following command in your terminal/shell

```sh
$ cargo install --git="https://github.com/knassar702/hacks" get-title
```

**OR**
Dowload The source and run:

```sh
$ cargo build --release && mv target/release/get-title ~/.cargo/bin/.
```

now you should be able to run `get-title` in your terminal

## Usage

Basic usage would be like :

```sh
cat urls.txt | get-title
```

### Options

run ``get-title --help`` to see available options:
<br>
```sh
$ get-title --help

get-title 0.1.0
Takes a list of urls and prints their titles

USAGE:
get-title [OPTIONS]

FLAGS:
-h, --help Prints help information
-V, --version Prints version information

OPTIONS:
-c <c> max concurrent [default: 40]
```