Skip to content

Commit

Permalink
feat: improve readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ryanamay committed Jan 10, 2022
1 parent 9f9e7e3 commit cfc7fd3
Showing 1 changed file with 44 additions and 2 deletions.
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit cfc7fd3

Please sign in to comment.