https://github.com/roxasshadow/humanity

Generate humans.txt from given repository's contributors list
https://github.com/roxasshadow/humanity

Last synced: 10 months ago
JSON representation

Generate humans.txt from given repository's contributors list

• Host: GitHub
• URL: https://github.com/roxasshadow/humanity
• Owner: RoxasShadow
• License: wtfpl
• Created: 2016-05-19T00:21:18.000Z (about 10 years ago)
• Default Branch: master
• Last Pushed: 2016-05-20T08:14:34.000Z (about 10 years ago)
• Last Synced: 2025-10-09T22:32:24.828Z (10 months ago)
• Language: Rust
• Homepage:
• Size: 28.3 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
humanity [![Build Status](https://travis-ci.org/RoxasShadow/humanity.svg?branch=master)](https://travis-ci.org/RoxasShadow/humanity) [![crates.io](http://meritbadge.herokuapp.com/humanity)](https://crates.io/crates/humanity)

========

Generate [humans.txt](http://humanstxt.org) from given repository's contributors list.

# Usage

To compile *humanity*, [Rust Nightly](https://www.rust-lang.org/downloads.html) is required.

```sh

$ cargo build --release

$ ./target/release/humanity iron/params

```

If the program crashes, it's because GitHub APIs allow you to execute a very low amount of requests.

What you have to do is just generating a new [token](https://github.com/settings/tokens/new) (pick

a name, leave everything unchecked and press "Generate token") and run `export GITHUB_ACCESS_TOKEN=`,

appending the received token.

If you need access to your private repositories, check the "repo" flag for your token.

# Customizations

It's possible to create additional fetchers implenting the `HumanityBearer` trait and also redefining

the output format using a custom implementation of `ToString` for `Humanity` and `User`.

# One last thing

![;_;](https://pbs.twimg.com/media/Cimu_N5XIAESpG4.jpg:large)