mirror of https://github.com/mue/mue.git
Improve readme
This commit is contained in:
parent
a7c1006676
commit
fd98cd4af1
20
README.md
20
README.md
|
@ -4,10 +4,10 @@
|
|||
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/fba7ad7fc6e14fe0bc2a8d53dbf0bb41)](https://www.codacy.com/app/ohlookitsderpy/Mue?utm_source=github.com&utm_medium=referral&utm_content=ohlookitsderpy/Mue&utm_campaign=Badge_Grade)
|
||||
[![Discord Badge](https://discordapp.com/api/guilds/336039472250748928/widget.png)](https://discord.gg/HJmmmTB)
|
||||
|
||||
<a href='https://ko-fi.com/ohlookitsderpy' target='_blank'><img height='36' src='assets/kofi.png' alt='Buy me a Coffee at ko-fi.com' /></a>
|
||||
<a href='https://ko-fi.com/ohlookitsderpy' target='_blank'><img height='36' src='assets/kofi.png' alt='Buy me a coffee at ko-fi.com' /></a>
|
||||
<a href='https://patreon.com/ohlookitsderpy' target='_blank'><img height='36' src='assets/patreon.png' alt='Become a patron on patreon.com' /></a>
|
||||
|
||||
Fast, open and free-to-use new tab page for most modern browsers
|
||||
Fast, open and free-to-use new tab page for most modern browsers.
|
||||
|
||||
## Features
|
||||
* Fast and free
|
||||
|
@ -21,15 +21,17 @@ Fast, open and free-to-use new tab page for most modern browsers
|
|||
|
||||
Link: [Chrome Web Store](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
|
||||
|
||||
Development: Read the [Development](#development) section
|
||||
Development: Read the [Development](#development) section.
|
||||
### Firefox
|
||||
<a href='https://addons.mozilla.org/firefox/addon/mue'><img src='assets/firefox.png' target='_blank'></a>
|
||||
|
||||
Link: [Firefox Add-ons](https://addons.mozilla.org/firefox/addon/mue)
|
||||
|
||||
Development: Read the [Development](#development) section
|
||||
Development: Read the [Development](#development) section.
|
||||
### Opera/Other
|
||||
Development: Read the [Development](#development) section
|
||||
Link: [GitHub Releases](https://github.com/ohlookitsderpy/Mue/releases)
|
||||
|
||||
Development: Read the [Development](#development) section.
|
||||
|
||||
### Development
|
||||
<h5>Requirements</h5>
|
||||
|
@ -42,12 +44,12 @@ Development: Read the [Development](#development) section
|
|||
<ol>
|
||||
<li> <code>git clone https://github.com/ohlookitsderpy/Mue</code> (If you don't have Git just go to <b>Clone or
|
||||
download</b> and click <b>Download ZIP</b>)
|
||||
<li>Open a terminal and run these commands: (in the Mue directory)
|
||||
<li> Open a terminal and run these commands: (in the Mue directory)
|
||||
<li> <code>yarn</code> (or <code>npm install</code>)
|
||||
<li> <code>yarn run sass-watch</code> (or <code>npm run sass-watch</code>)
|
||||
<li>Open another terminal and run this command: (in the Mue directory)
|
||||
<li> Open another terminal and run this command: (in the Mue directory)
|
||||
<li> <code>yarn run js-watch</code> (or <code>npm run js-watch</code>)
|
||||
<li>Start developing! (See the sections below for how to set it up with your browser)
|
||||
<li> Start developing! (See the sections below for how to set it up with your browser)
|
||||
</ol>
|
||||
<details>
|
||||
<summary><b>Chrome</b> (Click to expand)</summary>
|
||||
|
@ -94,7 +96,7 @@ Development: Read the [Development](#development) section
|
|||
|
||||
## Credits
|
||||
|
||||
[Turbomarshmello](https://github.com/TurboMarshmello) - Portions of original code, name idea
|
||||
[TurboMarshmello](https://github.com/TurboMarshmello) - Portions of original code, name idea
|
||||
|
||||
[Pexels](https://pexels.com) - Stock photos used
|
||||
|
||||
|
|
Loading…
Reference in New Issue