mirror of
https://github.com/ryanamay/pint.git
synced 2024-09-19 17:40:35 +00:00
docs: update documentation
This commit is contained in:
parent
9d0a711ce0
commit
870e0e9ba4
3 changed files with 52 additions and 41 deletions
41
README.md
41
README.md
|
@ -1,41 +0,0 @@
|
|||
<p align="center">
|
||||
<img width="50" src="https://github.com/nafunii/gh-accentify/blob/main/images/icon16.png?raw=true" alt="Profile Picture">
|
||||
<br> · Gitccentify ·
|
||||
<br> Personalize your GitHub experience by theming it to your own style!</p>
|
||||
</p>
|
||||
<hr>
|
||||
|
||||
![nFEf2ry1pk](https://user-images.githubusercontent.com/53419401/148857411-7896a24a-2374-4d64-a267-d1f599717a24.gif)
|
||||
|
||||
## Disclaimer
|
||||
*This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub, Inc. and Git, or any of its subsidiaries or its affiliates.*
|
||||
|
||||
## How it works
|
||||
Gitccentify taps into GitHub's css and changes it according to what you select on the extension popup.
|
||||
|
||||
## Installation
|
||||
You can install this extension via the Chrome Web Store or manually.
|
||||
|
||||
### Chrome Web Store
|
||||
Install it here: [Chrome Web Store](https://chrome.google.com/webstore/detail/mjhmdkcefcklflcmmokoahfdodcpeobg)
|
||||
|
||||
### Manual Installation
|
||||
1. Clone/Download this repository or download the latest [release](https://github.com/nafunii/gh-accentify/releases).
|
||||
2. Extract the downloaded zip file somewhere.
|
||||
3. Go to your Chrome Extensions and turn on Developer Mode.
|
||||
4. Click on `Load Unpacked` and select on the folder where you extracted the zip file.
|
||||
5. Profit!
|
||||
|
||||
## Contributing
|
||||
Contributions are always welcome and I'd be really happy for any PR to be incorporated into this project.
|
||||
|
||||
So to contribute, just make sure to make a PR on the `dev` branch.
|
||||
|
||||
## Supporting this project
|
||||
This project is free and open-source with no intentions of ever going paid.
|
||||
|
||||
If you really want to though, you can star the project or you may [buy me a coffee](https://www.buymeacoffee.com/nafu), to help improve this project further. Thanks a lot!
|
||||
|
||||
## License
|
||||
This extension is licensed under the GPLv3 License.
|
||||
|
1
README.md
Symbolic link
1
README.md
Symbolic link
|
@ -0,0 +1 @@
|
|||
docs/README.md
|
51
docs/README.md
Normal file
51
docs/README.md
Normal file
|
@ -0,0 +1,51 @@
|
|||
|
||||
# <a href="https://projects.fuwa.sh/pint/"><img align="left" height="100" src="/docs/assets/pint-logo.png"/></a> **pint** (formerly gitccentify)
|
||||
![rewrite-status](https://img.shields.io/badge/status-rewrite-orange)
|
||||
![pint-status](https://img.shields.io/badge/pint-dev-red)
|
||||
![gitccentify-status](https://img.shields.io/badge/gitccentify-released-green)
|
||||
![chrome-web-store-version](https://img.shields.io/chrome-web-store/v/mjhmdkcefcklflcmmokoahfdodcpeobg)
|
||||
![chrome-web-store-users](https://img.shields.io/chrome-web-store/users/mjhmdkcefcklflcmmokoahfdodcpeobg)
|
||||
|
||||
<hr>
|
||||
|
||||
###### INFO: Gitccentify is undergoing a major overhaul and will be renamed to pint. Information on this readme may be out of date.
|
||||
|
||||
|
||||
[pint](https://projects.fuwa.sh/pint/) is a browser extension that makes your github experience colorful, just the way you like it.
|
||||
<br>
|
||||
<br>
|
||||
|
||||
![nFEf2ry1pk](https://user-images.githubusercontent.com/53419401/148857411-7896a24a-2374-4d64-a267-d1f599717a24.gif)
|
||||
|
||||
|
||||
|
||||
|
||||
## Installation
|
||||
You can install this extension via the Chrome Web Store or manually.
|
||||
|
||||
![Get it on the Chrome Web Store](https://storage.googleapis.com/web-dev-uploads/image/WlD8wC6g8khYWPJUsQceQkhXSlv1/UV4C4ybeBTsZt43U4xis.png)
|
||||
|
||||
### Manual Installation
|
||||
1. Clone/Download this repository or download the latest [release](https://github.com/nafunii/gh-accentify/releases).
|
||||
2. Extract the downloaded zip file somewhere.
|
||||
3. Go to your Chrome Extensions and turn on Developer Mode.
|
||||
4. Click on `Load Unpacked` and select on the folder where you extracted the zip file.
|
||||
5. Profit!
|
||||
|
||||
## Roadmap
|
||||
As gitccentify stagnated in development, I decided to overhaul gitccentify while it's not there in the mainstream yet. The roadmap I plan to follow is right here/
|
||||
- [ ] Overhaul Gitccentify and release as pint. `*RELEASE MARK`
|
||||
- [ ] Implement additional features in my backlog
|
||||
|
||||
## Contributing
|
||||
Contributions are currently on hold as I overhaul this project. I'll be accepting contibutions once pint is released.
|
||||
|
||||
|
||||
|
||||
<p align="center"><br><a href="https://projects.fuwa.sh/pint"><img height="25" src="/docs/assets/pint-logo.png"/></a><br><a href="https://projects.fuwa.sh/pint">pint</a> • by <a href="https://fuwa.sh">fuwaa</a></p>
|
||||
|
||||
<hr>
|
||||
|
||||
###### This extension is licensed under the GPLv3 License.
|
||||
|
||||
###### This project is not affiliated, associated, authorized, endorsed by, or in any way officially connected with GitHub, Inc. and Git, or any of its subsidiaries or its affiliates.
|
BIN
docs/assets/pint-logo.png
Normal file
BIN
docs/assets/pint-logo.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 27 KiB |
Loading…
Reference in a new issue