From 51ad989a949c7501228614119ea55338c62f9298 Mon Sep 17 00:00:00 2001 From: Nek-12 Date: Fri, 28 Aug 2020 21:01:04 +0300 Subject: [PATCH 1/2] Fixed and improved installation instructions --- README.md | 65 +++++++++++++++++++++++++++++++++---------------------- 1 file changed, 39 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 7d51b21..ad619cf 100644 --- a/README.md +++ b/README.md @@ -12,23 +12,52 @@ want to contribute? check out the [contribution guidelines](CONTRIBUTING.md) and for support, join the [discord server](https://discord.gg/sFWPXtA). +### supported desktop clients + +- the [official windows/mac releases](https://notion.so/desktop). +- the arch linux AUR [notion-app](https://aur.archlinux.org/packages/notion-app/) package. +- the linux [notion-app](https://github.com/jaredallard/notion-app) installer. +- the debian [notion-deb-builder](https://github.com/davidbailey00/notion-deb-builder/). + +(it can also be run from the wsl to apply enhancements to the windows app.) + +**using a not-yet-supported operating system or notion installation?** ask for +[platform support](https://github.com/dragonwocky/notion-enhancer/issues/new?labels=enhancement&template=platform-support.md). + +mobile clients are not supported and due to system limitations/restrictions cannot be. + +a chrome extension may be coming soon for web client support. + ## installation **coming from <= v0.7.0? things are a bit different - have a read of [the update guide](UPDATING.md)** **before following these instructions.** -on arch linux? use the aur package: -[https://aur.archlinux.org/packages/notion-enhancer](https://aur.archlinux.org/packages/notion-enhancer) +
+ **Windows, macOS** -otherwise: +1. [install node.js](https://nodejs.org/en/download/) (_a computer restart may be required here._) +2. make sure no notion processes are running +3. execute `npm i -g notion-enhancer` in the terminal/command prompt. Make sure you have root/admin rights. +
-1. install node.js: [windows/macOS](https://nodejs.org/en/download/), linux/WSL: - ```bash - curl -sL https://deb.nodesource.com/setup_current.x | sudo -E bash - - sudo apt-get install -y nodejs - ``` - _a computer restart may be required here._ -2. make sure no notion processes are running (check the task manager!), and install the enhancer globally: run `npm i -g notion-enhancer` in the terminal/command prompt. +
+ **Ubuntu-based distros, WSL, ChromeOS** + +Execute the following commands: +``` +bash curl -sL https://deb.nodesource.com setup_current.x | sudo -E bash - +sudo apt-get install -y nodejs +sudo npm i -g notion-enhancer +``` +
+ +
+ **Arch Linux, Manjaro:** + +Use the [AUR package]( https://aur.archlinux.org/packages/notion-enhancer ). +install with `yay -S notion-enhancer` (use your AUR helper instead of yay) +
### command-line interface @@ -60,22 +89,6 @@ Options: -v, --version : display version number ``` -### supported clients - -- the [official windows/mac releases](https://notion.so/desktop). -- the arch linux AUR [notion-app](https://aur.archlinux.org/packages/notion-app/) package. -- the linux [notion-app](https://github.com/jaredallard/notion-app) installer. -- the debian [notion-deb-builder](https://github.com/davidbailey00/notion-deb-builder/). - -(it can also be run from the wsl to apply enhancements to the windows app.) - -**using a not-yet-supported operating system or notion installation?** ask for -[platform support](https://github.com/dragonwocky/notion-enhancer/issues/new?labels=enhancement&template=platform-support.md). - -mobile clients are not supported and due to system limitations/restrictions cannot be. - -a chrome extension may be coming soon for web client support. - **is this against notion's terms of service? can i get in trouble for using it?** definitely not! i contacted their support team to check, and the response was awesome: From ff3a89f65cf5bd8bd2c5a2b0965e5382db0cb566 Mon Sep 17 00:00:00 2001 From: Nek-12 Date: Fri, 28 Aug 2020 21:05:06 +0300 Subject: [PATCH 2/2] Github doesn't like markdown inside html blocks --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index ad619cf..33e0aad 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ a chrome extension may be coming soon for web client support. **before following these instructions.**
- **Windows, macOS** + Windows, macOS 1. [install node.js](https://nodejs.org/en/download/) (_a computer restart may be required here._) 2. make sure no notion processes are running @@ -42,7 +42,7 @@ a chrome extension may be coming soon for web client support.
- **Ubuntu-based distros, WSL, ChromeOS** + Ubuntu-based distros, WSL, ChromeOS Execute the following commands: ``` @@ -53,7 +53,7 @@ sudo npm i -g notion-enhancer
- **Arch Linux, Manjaro:** + Arch Linux, Manjaro: Use the [AUR package]( https://aur.archlinux.org/packages/notion-enhancer ). install with `yay -S notion-enhancer` (use your AUR helper instead of yay)