aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorErlend Lind Madsen <erlendf80@gmail.com>2022-01-15 04:08:44 +0100
committerErlend Lind Madsen <erlendf80@gmail.com>2022-01-15 04:08:44 +0100
commita90510efb778f928098affe3af7da18a8ec71d0f (patch)
treef34eee070c1ccb89e5d7ed643f8611d757e71f04
parent3554c4a5ec9e833a67227749f3abecd2773fc6e1 (diff)
downloadvis-minimal-theme-a90510efb778f928098affe3af7da18a8ec71d0f.tar.gz
README: link to vis-plug and improve text
-rw-r--r--README.md14
1 files changed, 9 insertions, 5 deletions
diff --git a/README.md b/README.md
index 80a06e5..4fae9c7 100644
--- a/README.md
+++ b/README.md
@@ -1,18 +1,22 @@
# vis-minimal-theme
-A minimal B&W theme for the [vis](https://github.com/martanne/vis) editor in both dark and light versions:
+A minimal black and white theme for [vis](https://github.com/martanne/vis) in both dark and light versions:
- minimal-dark
+
<img width="400" alt="minimal-dark" src="https://user-images.githubusercontent.com/1562523/149605406-8e859f34-9f27-4a7f-a08e-76b64c9a71f4.png">
-- minimal-light
+- minimal-light
+
<img width="400" alt="minimal-light" src="https://user-images.githubusercontent.com/1562523/149605422-dd55be44-7969-4096-b16e-9d5c53c63872.png">
-We only use 3 shades of black and 3 shades of white.
+We only uses 3 shades of dark and 3 shades of light per theme.
## Install
-Install manually or using `vis-plug`:
+Install manually or using [vis-plug](https://github.com/erf/vis-plug)
+
+Example `visrc.lua`:
```Lua
local plug = require('plugins/vis-plug')
@@ -30,4 +34,4 @@ vis.events.subscribe(vis.events.INIT, function()
end)
-```
+``` \ No newline at end of file