diff --git a/README.md b/README.md index a7f0ee84..47f39067 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,89 @@ -![Logo](https://github.com/muetab/branding/raw/master/logo/logo_horizontal.png) + + -# Mue -Fast, open and free-to-use new tab page for most modern browsers. +> Mue + +[![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)]() +
+[![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 + +
+ +## 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) +
+[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) +
+[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
  1. Git (optional)
    2. -
  2. Node.js
    3. +
  3. Node.JS
  4. A suitable browser
Starting
    -
  1. git clone https://github.com/mue/mue (If you don't have Git just go to Clone or - download and click Download ZIP) -
  2. Open a terminal and run these commands: (in the Mue directory) -
  3. yarn (or npm i) -
  4. yarn start (or npm start) -
  5. Start developing! (See the sections below for how to build the extension) +
  6. clone the repository using git clone https://github.com/mue/mue.git +
  7. run yarn or npm i to install all needed dependencies +
  8. run yarn start or npm start to start testing +
  9. Code your heart out! (See the sections below for how to build the extension)

Building

Chrome/Edge (Chromium) (Click to expand)
    -
  1. yarn run build (or npm run build) +
  2. yarn run build or npm run build
  3. Rename manifest-chrome.json in the "manfiest" folder to manifest.json in "build"
  4. Visit chrome://extensions in Chrome
  5. Click Load unpacked (Make sure Developer Mode is on) @@ -65,7 +93,7 @@ Development/Other: Read the [Development](#development) section.
    Opera (Click to expand)
      -
    1. yarn run build (or npm run build) +
    2. yarn run build or npm run build
    3. Rename manifest-opera.json in the "manfiest" folder to manifest.json in "build"
    4. Copy in the "manifest" folder to "build"
    5. Visit about://extensions in Opera @@ -76,7 +104,7 @@ Development/Other: Read the [Development](#development) section.
      Firefox (Click to expand)
        -
      1. yarn run build (or npm run build) +
      2. yarn run build or npm run build
      3. Rename manifest-firefox.json in the "manfiest" folder to manifest.json in "build"
      4. Move manifest/background-opera.js to build/background-opera.js
      5. Visit about:debugging#addons in Firefox @@ -89,31 +117,27 @@ Development/Other: Read the [Development](#development) section. Other (Click to expand) Note: To get the full new tab experience, set your browser to open the index.html on startup and tab open!
          -
        1. yarn run build (or npm run build) +
        2. yarn run build or npm run build
        3. Open the index.html in your browser
        4. Enjoy your new tab!
      -## 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
      +[TurboMarshmello](https://github.com/TurboMarshmello) - Name, Lead design,
      ### 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
      [Google Fonts](https://fonts.google.com/specimen/Lexend+Deca) - Lexend Deca font -and all the contributors <3 +### Contributors +[Wessel](https://github.com/Wessel) - Development
      +[Isaac](https://github.com/eartharoid) - Development
      +[Chris](https://github.com/auguwu) - Development
      -# 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