mirror of
https://github.com/ryanamay/pint.git
synced 2024-09-20 01:50:34 +00:00
feat: improve readme
This commit is contained in:
parent
9f9e7e362f
commit
cfc7fd3170
1 changed files with 44 additions and 2 deletions
46
README.md
46
README.md
|
@ -1,2 +1,44 @@
|
|||
# gh-accentify
|
||||
Personalize your GitHub experience.
|
||||
<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>
|
||||
<hr>
|
||||
<p align="center"> <strong>⚠️ This project is heavily under development. ⚠️</strong>
|
||||
<br> <em>Things may and will break probably in the future, some things may also change.</em>
|
||||
</p>
|
||||
<hr>
|
||||
|
||||
![paHIBp6Vv9](https://user-images.githubusercontent.com/53419401/148716438-100e099d-02bb-41ae-b4ab-64c252131cd4.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 (coming soon) or manually.
|
||||
|
||||
### Chrome Web Store
|
||||
(Chrome Web Store Link Soon)
|
||||
|
||||
### 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 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.
|
||||
|
||||
|
|
Loading…
Reference in a new issue