diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f3bc93e..f9ad76f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,7 +19,7 @@ following them shows respect to the developer/s spending their free time on it, **know your way around notion/electron/js/css and have some code to contribute?** great! read below for guidelines on how to create a helpful pull request and what happens with your code afterwards. it's probably also helpful to -join the [discord server](//coming-soon) +join the [discord server](//coming-soon). **for information on how to actually create a theme or module with the notion-enhancer api, check the [docs](DOCUMENTATION.md).** diff --git a/DOCUMENTATION.md b/DOCUMENTATION.md index e033195..0c0bbb8 100644 --- a/DOCUMENTATION.md +++ b/DOCUMENTATION.md @@ -1,8 +1,6 @@ # documentation -ended up here? this is a wip version of the enhancer, and this file is yet to be completed. -if you're interested in using the project, switch back to the [master branch](https://github.com/dragonwocky/notion-enhancer). -for support, contact me on discord `dragonwocky#8449` or open an issue here in the repo. +for support, join the [discord server](//coming-soon). want to contribute? check the [contribution guidelines](CONTRIBUTING.md). diff --git a/README.md b/README.md index 7cb3124..2cb6a73 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,8 @@ # notion-enhancer +ended up here? this is a work-in-progress version of the enhancer, not ready for public use. +if you're interested in using the project, switch back to the [master branch](https://github.com/dragonwocky/notion-enhancer). + notion.so is a pretty awesome tool already, but there's always room for improvements. it might just be a preference, it might be something crucial to your setup, it might be something users have been asking for for a long time, @@ -12,6 +15,8 @@ want to contribute? check out the [contribution guidelines](CONTRIBUTING.md) and ## installation +**coming from v0.7.0? things are a bit different - have a read of [the update guide](UPDATING.md).** + 1. install node.js: [windows/macOS](https://nodejs.org/en/download/), [linux/WSL](https://github.com/mklement0/n-install). _a computer restart may be required here._ 2. install the enhancer globally: run `npm i -g notion-enhancer` in the terminal/command prompt. @@ -66,7 +71,7 @@ team to take to heart for future improvements." ## features -once applied, modules can be configured via the graphical (filterable and searchable) menu, which can be opened from +once applied, modules can be configured via the graphical menu, which is opened from the tray/menubar icon or with `CMD/CTRL+E`. currently all modules come pre-installed for technical reasons, security assurance, and ease-of-use. diff --git a/TWEAKS.md b/TWEAKS.md new file mode 100644 index 0000000..e69de29 diff --git a/UPDATING.md b/UPDATING.md new file mode 100644 index 0000000..5269a50 --- /dev/null +++ b/UPDATING.md @@ -0,0 +1,45 @@ +# updating + +the enhancer is still a young project, so it's growing quickly. this means a lot of stuff is changing internally +\- and, sometimes, externally. + +previously (<= v0.7.0), the enhancer was a python script with a couple of resource files, and if you +wanted to customise things you had to go in and edit those files. in v0.8.0 there has been a complete +rewrite and overhaul: now this is a program that makes use of a number of modules and a graphical menu. + +## installation dependencies + +previously, python and the node.js `asar` package were both required. +node.js is the only current requirement of the enhancer. + +- python is no longer a dependency: keep it, get rid of it - up to you. +- the package installs asar itself in a more scoped environment: if you're confident with + the command line, you can remove the package with `npm remove -g asar`. otherwise, it + won't do any damage to just leave it. + +## keeping the files + +enhancement is done fully from the command prompt. +by default, there are no files for you to worry about. + +you can delete the folder the old version of the enhancer is kept in. +(though you may want to keep the `user.css` file: see below.) + +## user.css styling + +when you first load the enhancer, there's no single file you can edit to see instant changes. +instead, the "custom inserts" module is used: you can use it to pick any javascript or css file anywhere +on your computer and include it every time you load up notion. + +most of the same css snippets will work, but some (e.g. preview page width) have been moved to the new variable +system, plus new ones have been found. it's a good idea to check what you have against the [tweaks](TWEAKS.md) +page and the [css theming documentation](DOCUMENTATION.md#theming). + +## configuration + +"what happened to the tray options?" + +"how can I set a custom window visibility toggle hotkey?" + +these options and more have been moved to the graphical menu, which can be opened from the +tray or with `CMD/CTRL+E` (while the notion app is focused).