From ea24e2653aeb29b6bd4446d4f3efa1957da150c7 Mon Sep 17 00:00:00 2001 From: Wessel T Date: Sat, 27 Mar 2021 13:32:51 +0100 Subject: [PATCH] style: md in favour of html, add automatic toc --- README.md | 90 +++++++++++++++++-------------------------------------- 1 file changed, 28 insertions(+), 62 deletions(-) diff --git a/README.md b/README.md index ec9c2ba5..f58348e2 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,7 @@ Mue is a fast, open and free-to-use browser extension that gives a new, fresh an
## Table of contents -* [Screenshot](#screenshot) -* [Features](#features) -* [Planned Features](#planned-features) -* [Installation](#installation) - * [Chrome](#chrome) - * [Firefox](#firefox) - * [Edge Chromium](#edge-chromium) - * [Naver](#naver) - * [Other](#other) -* [Contributing](#development) - * [Requirements](#requirements) - * [Starting](#starting) - * [Building](#building) -* [Credits](#credits) - * [Maintainers](#maintainers) - * [Contributors](#contributors) - * [Translators](#translators) - +[[toc]] ## Screenshot ![Screenshot](assets/screenshot.jpg) @@ -69,21 +52,17 @@ Please note that we have dropped support for Opera as of Mue 5.0 [GitHub Releases](https://github.com/mue/mue/releases) -### Development +## Development #### Requirements -
    -
  1. Git
  2. -
  3. Node.JS
  4. -
  5. A suitable browser
  6. -
-
Starting
-
    -
  1. Clone the repository using git clone https://github.com/mue/mue.git -
  2. Run yarn or npm i to install all needed dependencies -
  3. Run yarn start or npm start to start testing -
  4. Code your heart out! (See the sections below for how to build the extension) -
-

Building

+ * [Git](https://git-scm.com/) + * [Node.JS](https://nodejs.org/) + * A suitable browser +#### Starting + 1. Clone the repository using `git clone https://github.com/mue/mue.git` + 2. Run `yarn` or `npm i` to install all needed dependencies + 3. Run `yarn start` or `npm start` to start testing + 4. Code your heart out! (See the sections below for how to build the extension) +#### Building
Chrome/Edge (Chromium) (Click to expand)
    @@ -128,36 +107,23 @@ Please note that we have dropped support for Opera as of Mue 5.0
## Credits -### Core Team -#### Developers -[David Ralph](https://github.com/davidjcralph) - Lead development, photographer
- -[Alex Sparkes](https://github.com/alexsparkes) - Name, lead design, photographer
- -[Isaac Saunders](https://github.com/eartharoid) - QA, development, photographer
- -[Wessel Tip](https://github.com/Wessel) - Development
- +### Developers +[David Ralph](https://github.com/davidjcralph) - Lead development, photographer
+[Alex Sparkes](https://github.com/alexsparkes) - Name, lead design, photographer
+[Isaac Saunders](https://github.com/eartharoid) - QA, development, photographer
+[Wessel Tip](https://github.com/Wessel) - Development
### Translators -[Wessel Tip](https://github.com/Wessel) - Dutch - -[Alex Sparkes](https://github.com/alexsparkes), [Maxime](https://github.com/exiam) - French - -[Anders](https://github.com/FuryingFox) - Norwegian - -[Pronin Egor](https://github.com/MrZillaGold) - Russian - -[Vicente](https://github.com/Vicente015) - Spanish - -[Austin Huang](https://github.com/austinhuang0131) - Chinese (Simplified) - -[FreeFun](https://github.com/xXFreeFunXx) - Germany - -### Resources -[Pexels](https://pexels.com) - Stock photos used for offline mode - -[Opera Forum](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14) - Portions of code to add Opera support - +[Wessel Tip](https://github.com/Wessel) - Dutch
+[Alex Sparkes](https://github.com/alexsparkes), [Maxime](https://github.com/exiam) - French
+[Anders](https://github.com/FuryingFox) - Norwegian
+[Pronin Egor](https://github.com/MrZillaGold) - Russian
+[Vicente](https://github.com/Vicente015) - Spanish
+[Austin Huang](https://github.com/austinhuang0131) - Chinese (Simplified)
+[FreeFun](https://github.com/xXFreeFunXx) - German
+### Contributors Many thanks to [Highholding](https://discord.bio/p/highholding), [Noa Shapira](#), [Roee Lupo](https://github.com/RoeeLupo), [Jeroen](#), [Glasvegas](https://twitter.com/_glasvegas), [Anders](https://github.com/FuryingFox), [Oded Shapira](https://twitter.com/dondishdev), Jacob Tyrrell and [Nikka Lai](#) for letting us use their wonderful photographs. -And finally, a big thank you to all the [contributors](https://github.com/mue/mue/graphs/contributors)! +And finally, a big thank you to all the other [contributors](https://github.com/mue/mue/graphs/contributors)! +### Resources +[Pexels](https://pexels.com) - Stock photos used for offline mode
+[Opera Forum](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14) - Portions of code to add Opera support