https://github.com/keiya01/thanks-dependencies

Generate a dependency list to thank them on README.
https://github.com/keiya01/thanks-dependencies

Last synced: 2 months ago
JSON representation

Generate a dependency list to thank them on README.

• Host: GitHub
• URL: https://github.com/keiya01/thanks-dependencies
• Owner: keiya01
• License: mit
• Created: 2023-01-29T12:29:52.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2023-01-30T07:27:53.000Z (almost 2 years ago)
• Last Synced: 2024-09-09T13:15:38.511Z (4 months ago)
• Language: Rust
• Homepage:
• Size: 41 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# thanks-dependencies

This generates list of dependencies.

I think it's better to publish dependencies explicitly on documentation. Of course users can refer dependencies from `Cargo.toml`, but almost users don't interest for what's library used.

So publishing dependencies explicitly forces users to look at these, and it can advertize these. Additionally it should be motivation for continuing maintenance.

To do this, we need to search dependencies and write information manually, but it's really stressful.

So this tool automate these task. And it generates [Thanks for the following dependencies](#Thanks-for-the-following-dependencies).

## Installation

```sh

$ cargo install thanks-dependencies

```

## Usage

Only run command as follows.

```sh

$ thanks-dependencies

```

It has the following options.

```sh

$ thanks-dependencies -h

Usage: thanks-dependencies [OPTIONS]

Options:

  -r, --readme   Path for your README.md [default: ./README.md]

  -c, --cargo     Path for your Cargo.toml [default: ./Cargo.toml]

  -t, --title     Title for thanks list [default: "## Thanks for the following dependencies"]

      --recursive        Whether reading dependencies recursively

  -h, --help             Print help

```

## Thanks for the following dependencies

### Dependencies

- async-recursion(https://github.com/dcchut/async-recursion) ... Recursion for async functions

- cargo_toml(https://gitlab.com/crates.rs/cargo_toml) ... `Cargo.toml` struct definitions for parsing with Serde

- clap(https://github.com/clap-rs/clap) ... A simple to use, efficient, and full-featured Command Line Argument Parser

- futures(https://github.com/rust-lang/futures-rs) ... An implementation of futures and streams featuring zero allocations, composability, and iterator-like interfaces. 

- futures-util(https://github.com/rust-lang/futures-rs) ... Common utilities and extension traits for the futures-rs library. 

- serde(https://github.com/serde-rs/serde) ... A generic serialization/deserialization framework

- surf(https://github.com/http-rs/surf) ... Surf the web - HTTP client framework