https://github.com/albingroen/gh-status-updater
A simple command you can use to update your GitHub profile status.
https://github.com/albingroen/gh-status-updater
github javascript node status
Last synced: 3 months ago
JSON representation
A simple command you can use to update your GitHub profile status.
- Host: GitHub
- URL: https://github.com/albingroen/gh-status-updater
- Owner: albingroen
- Created: 2021-05-24T18:01:59.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-05-25T08:33:52.000Z (about 5 years ago)
- Last Synced: 2025-10-01T15:11:23.783Z (10 months ago)
- Topics: github, javascript, node, status
- Language: JavaScript
- Homepage: https://github.com/albingroen/gh-status-updater
- Size: 17.6 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# gh-status-updater
A simple command you can use to update your GitHub profile status.
## Installation
Use the package manager [npm](https://www.npmjs.com) to install gh-status-updater.
```bash
npm install -g gh-status-updater
```
## Usage
### CLI
```bash
update-gh-status
# GitHub user-level access token (Only necessary on first run)
--token=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
# The message of the status
--message="Working from home"
# The emoji of the status
--emoji=🏡
```
### JavaScript module
```javascript
import updateGhStatus from "gh-status-updater";
await updateGhStatus("Working from home", "🏡", "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
```
## Demo
https://user-images.githubusercontent.com/19674362/119400065-f0def200-bcd9-11eb-8486-d41c008a9165.mp4
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
## License
[MIT](https://choosealicense.com/licenses/mit/)