❤️ it? ⭐️ it on GitHub or Tweet about it.

Table of Contents

• Installation
• Usage
• FAQs
• Issues
  • 🐛 Bugs
• LICENSE

Installation

Ensure you have Node.js 10 or later installed. Then run the following:

npx stargazed [options]

Usage

$ stargazed --help

  Creating your own Awesome List of GitHub Stars!

  Options
    -u, --username TEXT    GitHub username
    -t, --token TEXT       GitHub token
    -s, --sort             sort by language
    -r, --repository TEXT  repository name
    -m, --message TEXT     commit message
    -w, --workflow         Setup GitHub Actions for Daily AutoUpdate
    -v, --version          Show the version and exit with code 0

  Examples
    $ stargazed --username abhijithvijayan --token "GITHUB-TOKEN" --repository "awesome-stars"  --sort --workflow
    $ stargazed -u "abhijithvijayan" -r "awesome-stars" -t "GITHUB-TOKEN" -m "COMMIT_MESSAGE" -s

Demo

• abhijithvijayan/awesome-stars

FAQs

Generate new token

Goto Personal access tokens

Why do I need a token

• For unauthenticated requests, the rate limit is 60 requests per hour. see Rate Limiting
• The token must be passed together when you want to automatically create the repository.

How can I automate the process after initial run

Use -w, --workflow flag to set up GitHub workflow that updates the repo at 00:30 everyday

stargazed -u "abhijithvijayan" -r "awesome-stars" -t "GITHUB-TOKEN" -s -w

Issues

Looking to contribute? Look for the Good First Issue label.

See contribution guidelines

🐛 Bugs

Please file an issue here for bugs, missing documentation, or unexpected behavior.

See Bugs

Linting Config

• Shared Eslint & Prettier Configuration - @abhijithvijayan/eslint-config

License

MIT © Abhijith Vijayan