Skip to content

Commit 4b885e3

Browse files
committed
docs(README): installation instructions, username changes, badges
1 parent 75a35f3 commit 4b885e3

File tree

1 file changed

+16
-9
lines changed

1 file changed

+16
-9
lines changed

README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -23,14 +23,13 @@
2323

2424
![status](https://img.shields.io/badge/status-beta-e89829)
2525
![version](https://img.shields.io/badge/version-1.0.0-5895C9)
26-
[![tags](https://img.shields.io/github/tag/brianclements/logseq-color-markup?include_prereleases=&sort=semver&color=blue)](https://github.com/brianclements/logseq-color-markup/releases/)
27-
[![release](https://img.shields.io/github/v/release/brianclements/logseq-color-markup?color=5895C9)](https://github.com/brianclements/logseq-color-markup/releases)
26+
[![release](https://img.shields.io/github/v/release/clemtibs/logseq-color-markup?color=5895C9)](https://github.com/clemtibs/logseq-color-markup/releases)
2827

2928
</div>
3029
<div align="center">
3130

3231
[![license](https://img.shields.io/badge/License-MIT-blue)](#license)
33-
![downloads](https://img.shields.io/github/downloads/brianclements/logseq-color-markup/total.svg?color=D25584)
32+
![downloads](https://img.shields.io/github/downloads/clemtibs/logseq-color-markup/total.svg?color=D25584)
3433

3534
</div>
3635

@@ -41,7 +40,7 @@ Add more color options to your highlights and text in Logseq using slash command
4140
## Background
4241

4342
This plugin was created to fill the gap left when converting my Workflowy maps
44-
to Logseq using [WF2LS](https://github.com/brianclements/wf2ls), but is
43+
to Logseq using [WF2LS](https://github.com/clemtibs/wf2ls), but is
4544
completely functional on it's own. Workflowy supports 10 colors for both
4645
highlights and text color, and this plugin enables that functionality with slash
4746
commands.
@@ -125,10 +124,18 @@ Slash commands:
125124

126125
## Installation
127126

128-
- Clone the repo
129-
- Open the _plugin_ option in Logseq Desktop Client
130-
- Select **Load unpacked plugin** in Logseq Desktop client
131-
- Open the _src_ folder of the repo (where "package.json" is)
127+
### From Logseq Marketplace (recommended):
128+
129+
- Click **"..."** and open the **Plugins** section (or press `t p`)
130+
- Click on the **Marketplace**
131+
- On the **Plugins** tab search for **Color Markup** plugin and click install
132+
133+
### Manually
134+
135+
- Enable **Developer mode** in **...****Settings****Advanced**
136+
- Download the latest plugin release in a raw .zip archive from [here](https://github.com/clemtibs/logseq-color-markup/releases/latest) and unzip it
137+
- Go to the **"..."****Plugins**, click **"Load unpacked plugin"** and point to the unzipped plugin (where "package.json" is)
138+
- Note that every new plugin release needs to be updated manually
132139

133140
## Credits
134141

@@ -140,4 +147,4 @@ Slash commands:
140147

141148
## License
142149

143-
[MIT License](https://github.com/brianclements/logseq-color-markup/blob/main/LICENSE)
150+
[MIT License](https://github.com/clemtibs/logseq-color-markup/blob/main/LICENSE)

0 commit comments

Comments
 (0)