Skip to content

Commit

Permalink
README.md Updated
Browse files Browse the repository at this point in the history
  • Loading branch information
AmraniCh committed Jul 1, 2021
1 parent ca6afc7 commit 3c6865a
Showing 1 changed file with 63 additions and 1 deletion.
64 changes: 63 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,63 @@
# github-code-font-changer
<br>

<p align="center">
<img src="https://i.ibb.co/brYBgZx/logo-wide.png" alt="GitHub Code Font Changer" width="500px" />
</p>

<p align="center">
</br>
<a href="#">
<img alt="version"
src="https://img.shields.io/github/manifest-json/v/AmraniCh/github-code-font-changer?filename=src%2Fmanifest.json&style=for-the-badge">
</a>
<a href="#">
<img alt="repo code size"
src="https://img.shields.io/github/languages/code-size/AmraniCh/github-code-font-changer?color=critical&style=for-the-badge">
</a>
<a href="https://github.com/AmraniCh/github-code-font-changer/blob/master/LICENSE">
<img alt="license"
src="https://img.shields.io/github/license/AmraniCh/github-code-font-changer?style=for-the-badge" />
</a>
<a href="#">
<img alt="lang"
src="https://img.shields.io/badge/lang-Pure%20JavaScript-yellow?style=for-the-badge" />
</a>
<br>
</p>

<p align="center">
<sub>Developped and maintained with ❤️ by <a href="https://github.com/AmraniCh">AmraniCh</a> and <a href="https://github.com/AmraniCh/github-code-font-changer/graphs/contributors">contributors</a>.</sub>
</p>

# Introduction

Unhappy with the boring GitHub code viewer font? You're looking for a way to change it without affecting other website's fonts? Well, this extension is made for you :raised_hands:.

# Features

- Change the font family from the predefined fonts provided by the extension.
- Change the font weight for the selected font family.
- Hide the code viewer indentation guides.

# Available fonts

- Fira Code.
- Source Code Pro.

If you have some other font that other developers could like, you can send a pull request to add it to this extension (The font must be free for personal use or licensed under a free open source license).

# How to install it ?

For this time, you can install this extension only via the developer mode in your Chrome browser.

1. Download the last stable version from [releases tab](https://github.com/AmraniCh/github-code-font-changer/releases).
2. Unzip the downloaded zip file.
3. Visit `chrome://extensions`.
4. Enable the developper mode.
5. Click `Load unpacked` button.
6. Select the `src` folder from the unzipped file.
7. Have fun :blush:!

# License

GitHub Code Font Changer is an open-source chrome extension lisenced under the [MIT](https://github.com/AmraniCh/github-code-font-changer/blob/master/LICENSE) open source lisence.

0 comments on commit 3c6865a

Please sign in to comment.