From 9357b706071faf6b57376853c7a5f8b753df4546 Mon Sep 17 00:00:00 2001 From: Tmpod Date: Sun, 7 Mar 2021 01:11:35 +0000 Subject: [PATCH] Micro tweaks + badges for tickets and lists --- README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3072a1f..de3d244 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,6 @@ +[![tickets](https://img.shields.io/badge/tickets-here-informational?style=flat-square&color=0062CC)](https://todo.sr.ht/~tmpod/memusage-lite) +[![mailing lists](https://img.shields.io/badge/mailing_lists-here-informational?style=flat-square&color=0062CC)](https://lists.sr.ht/~tmpod/memusage-lite) + # memusage-lite A simple plugin for [lite](https://github.com/rxi/lite) that adds a toggleable display of how much memory the Lua virtual machine is using. @@ -9,10 +12,11 @@ Navigate to your `data/plugins` directory and then use one of the following meth 1. Just download the plugin file into your plugins folder. ``` - curl https://git.sr.ht/~tmpod/-lite/blob/master/memusage.lua -o memusage.lua + curl -O https://git.sr.ht/~tmpod/memusage-lite/blob/master/memusage.lua ``` -2. Clone this repository into your plugins folder. This allows you to easily update the pluin by doing `git pull` but it fetches unnecessary files, such as this README. +2. Clone this repository into your plugins folder. This allows you to easily update the plugin by doing `git pull` but +it fetches unnecessary files, such as this README. ``` git clone https://git.sr.ht/~tmpod/memusage-lite ``` @@ -29,7 +33,8 @@ You can also configure it, as explained in the next section. ## Configurations This plugin has three configuration fields. -You can set these configurations by editing your `init.lua` file in the `data/user` lite directory and modifying the `core.config` table. +You can set these configurations by editing your `init.lua` file in the `data/user` lite directory and modifying the +`core.config` table. Each field name should be prefixed with `memusage_`, for example, `memusage_color`. Here's a description of each valid configuration field: -- 2.38.5