mirrors/mue
1
0
Fork 0
mirror of https://github.com/mue/mue.git synced 2026-07-09 21:45:26 +02:00
Code Issues Packages Projects Releases Wiki Activity

oops

Browse Source
This commit is contained in:
David Ralph
2020-07-15 21:22:23 +01:00
committed by GitHub
parent 0c6022aa2d
commit 0d017fa362
1 changed files with 65 additions and 41 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
README.md
View File

@@ -1,61 +1,89 @@
![Logo](https://github.com/muetab/branding/raw/master/logo/logo_horizontal.png)
<img src="https://raw.githubusercontent.com/mue/branding/master/logo/logo_round.png" align="left" width="180px" height="180px"/>
<img align="left" width="0" height="192px" hspace="10"/>
# Mue
Fast, open and free-to-use new tab page for most modern browsers.
> <a href="https://muetab.xyz/">Mue</a>
[![License](https://img.shields.io/badge/license-BSD%203-blue?style=flat-square)](/LICENSE) [![Discord](https://img.shields.io/discord/659129207208804381?label=discord&color=7289DA&style=flat-square)](https://discord.gg/zv8C9F8) [![Code Size]( https://img.shields.io/github/languages/code-size/mue/mue?color=green&label=size&style=flat-square)]()
<br>
[![Microsoft Edge](https://img.shields.io/badge/dynamic/json?style=flat-square&label=microsoft%20edge&query=%24.version&url=https%3A%2F%2Fmicrosoftedge.microsoft.com%2Faddons%2Fgetproductdetailsbycrxid%2Faepnglgjfokepefimhbnibfjekidhmja)]() [![](https://img.shields.io/amo/v/mue?label=firefox&style=flat-square)]() [![](https://img.shields.io/chrome-web-store/v/bngmbednanpcfochchhgbkookpiaiaid?label=chrome&style=flat-square)]()
Mue is a fast, open and free-to-use browser plugin gives a new, fresh and customizable tab page to most modern browsers
<br>
## Table of contents
* [Screenshot](#screenshot)
* [Features](#features)
* [Planned Features](#planned-features)
* [Installation](#installation)
* [Chrome](#chrome)
* [Firefox](#firefox)
* [Chromium](#edge-chromium)
* [Opera/Other](#operaother)
* [Contributing](#development)
* [Requirements](#requirements)
* [Starting](#starting)
* [Building](#building)
* [Credits](#credits)
* [Maintainers](#maintainers)
* [Contributors]()
* [Other](#other)
## Screenshot
*May be updated in the future*
![Screenshot](assets/screenshot.jpg)
## Features
* Fast and free
* Supports multiple browsers
* Actively developed and opensource
* Actively developed and open source
* Automatically updating API (with no tracking!) with new photos, quotes and offline mode
* Search bar
## Planned Features
* Settings feature - enable/disable features!
* Settings - enable/disable features!
* Update modal, copy button and more!
* Multiple language support
* Multilingual support
## Installation
Note: A demo of the tab can be found [here](https://mue.now.sh).
*A demo of the tab can be found [here](https://mue.now.sh)*
### Chrome
[![Chrome Web Store Logo](assets/chrome.png)](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
<br>
[Chrome Web Store](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
Link: [Chrome Web Store](https://chrome.google.com/webstore/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
Development: Read the [Development](#development) section.
### Firefox
[![Firefox Add-ons Logo](assets/firefox.png)](https://addons.mozilla.org/firefox/addon/mue)
<br>
[Firefox Add-ons](https://addons.mozilla.org/firefox/addon/mue)
Link: [Firefox Add-ons](https://addons.mozilla.org/firefox/addon/mue)
Development: Read the [Development](#development) section.
### Edge (Chromium)
Link: [Microsoft Edge Addons](https://microsoftedge.microsoft.com/addons/detail/aepnglgjfokepefimhbnibfjekidhmja)
### Opera/Other
Link: [GitHub Releases](https://github.com/ohlookitsderpy/Mue/releases)
[Microsoft Edge Addons](https://microsoftedge.microsoft.com/addons/detail/aepnglgjfokepefimhbnibfjekidhmja)
### Opera/Other
Link: [GitHub Releases](https://github.com/mue/mue/releases)
Development/Other: Read the [Development](#development) section.
### Development
##### Requirements
#### Requirements
<ol>
<li><a href='https://git-scm.com'>Git</a> (optional)</li>
<li><a href='https://nodejs.org'>Node.js</a></li>
<li><a href='https://nodejs.org'>Node.JS</a></li>
<li>A suitable browser</li>
</ol>
<h5>Starting</h5>
<ol>
<li> <code>git clone https://github.com/mue/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> <code>yarn</code> (or <code>npm i</code>)
<li> <code>yarn start</code> (or <code>npm start</code>)
<li> Start developing! (See the sections below for how to build the extension)
<li> clone the repository using <code>git clone https://github.com/mue/mue.git</code>
<li> run <code>yarn</code> or <code>npm i</code> to install all needed dependencies
<li> run <code>yarn start</code> or <code>npm start</code> to start testing
<li> Code your heart out! (See the sections below for how to build the extension)
</ol>
<h2>Building</h5>
<details>
<summary><b>Chrome/Edge (Chromium)</b> (Click to expand)</summary>
<ol>
<li> <code>yarn run build</code> (or <code>npm run build</code>)
<li> <code>yarn run build</code> or <code>npm run build</code>
<li> Rename <code>manifest-chrome.json</code> in the "manfiest" folder to <code>manifest.json</code> in "build"
<li> Visit <code>chrome://extensions</code> in Chrome
<li> Click <b>Load unpacked</b> (Make sure <b>Developer Mode</b> is on)
@@ -65,7 +93,7 @@ Development/Other: Read the [Development](#development) section.
<details>
<summary><b>Opera</b> (Click to expand)</summary>
<ol>
<li> <code>yarn run build</code> (or <code>npm run build</code>)
<li> <code>yarn run build</code> or <code>npm run build</code>
<li> Rename <code>manifest-opera.json</code> in the "manfiest" folder to <code>manifest.json</code> in "build"
<li> Copy <codebackground-opera.js</code> in the "manifest" folder to "build"
<li> Visit <code>about://extensions</code> in Opera
@@ -76,7 +104,7 @@ Development/Other: Read the [Development](#development) section.
<details>
<summary><b>Firefox</b> (Click to expand)</summary>
<ol>
<li> <code>yarn run build</code> (or <code>npm run build</code>)
<li> <code>yarn run build</code> or <code>npm run build</code>
<li> Rename <code>manifest-firefox.json</code> in the "manfiest" folder to <code>manifest.json</code> in "build"
<li> Move <code>manifest/background-opera.js</code> to <code>build/background-opera.js</code>
<li> Visit <code>about:debugging#addons</code> in Firefox
@@ -89,31 +117,27 @@ Development/Other: Read the [Development](#development) section.
<summary><b>Other</b> (Click to expand)</summary>
<i>Note: To get the full new tab experience, set your browser to open the <code>index.html</code> on startup and tab open!</i>
<ol>
<li> <code>yarn run build</code> (or <code>npm run build</code>)
<li> <code>yarn run build</code> or <code>npm run build</code>
<li> Open the <code>index.html</code> in your browser
<li> Enjoy your new tab!
</ol>
</details>
## Screenshot
*Will be updated if needed*
![Screenshot](assets/screenshot.jpg)
## Credits
### Maintainers
[ohlookitsderpy](https://github.com/ohlookitsderpy) (owner, lead developer)
[TurboMarshmello](https://github.com/TurboMarshmello) (name idea, lead designer)
[ohlookitsderpy](https://github.com/ohlookitsderpy) - Founder, Lead development, Photographer <br>
[TurboMarshmello](https://github.com/TurboMarshmello) - Name, Lead design, <br>
### Other
[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
[Opera Forum](https://forums.opera.com/topic/25046/how-to-disable-completely-the-speed-dial/14) - Portions of code to add Opera support <br>
[Google Fonts](https://fonts.google.com/specimen/Lexend+Deca) - Lexend Deca font
and all the contributors <3
### Contributors
[Wessel](https://github.com/Wessel) - Development <br>
[Isaac](https://github.com/eartharoid) - Development <br>
[Chris](https://github.com/auguwu) - Development <br>
# License
[BSD-3-Clause](LICENSE)
And many thanks to [Highholding](https://discord.bio/p/highholding), [Noa Shapira](#), [Roee Lupo](https://github.com/MrSheldon), [Jeroen](#), [Glasvegas](https://twitter.com/_glasvegas), [Anders](https://github.com/FuryingFox/), [Oded Shapira](https://twitter.com/dondishdev) and [Nikka Lai](#) for letting us use their wonderful photographs