Skip to content

Commit fbc28e9

Browse files
committed
docs: upgrade readme
1 parent fb3a7a3 commit fbc28e9

File tree

2 files changed

+40
-13
lines changed

2 files changed

+40
-13
lines changed

README.md

Lines changed: 40 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,43 @@
11
# Logseq Copilot 🚀
22

3-
[![Build](https://github.com/EINDEX/logseq-copilot/actions/workflows/build.yml/badge.svg)](https://github.com/EINDEX/logseq-copilot/actions/workflows/build.yml) [![codecov](https://codecov.io/github/EINDEX/logseq-copilot/branch/main/graph/badge.svg?token=Z70QAMVZR1)](https://codecov.io/github/EINDEX/logseq-copilot) ![License](https://img.shields.io/github/license/eindex/logseq-copilot)
3+
<p align="center">
4+
<a href="LICENSE" target="_blank">
5+
<img alt="GPL-3.0 License" src="https://img.shields.io/github/license/eindex/logseq-copilot.svg?style=flat-square" />
6+
</a>
47

5-
Logseq Copilot is a Chrome extension that allows you to access your Logseq using your browser. Logseq is a privacy-first, open-source platform for knowledge sharing and management. With Logseq Copilot, you can easily retrieve relevant information from your Logseq graph and enrich your online search, reading, and learning experience. 🧠
8+
<!-- TypeScript Badge -->
9+
<img alt="TypeScript" src="https://img.shields.io/badge/-TypeScript-blue?style=flat-square&logo=typescript&logoColor=white" />
10+
11+
<a href="https://chrome.google.com/webstore/detail/hihgfcgbmnbomabfdbajlbpnacndeihl" target="_blank">
12+
<img alt="Chrome" src="https://img.shields.io/chrome-web-store/stars/hihgfcgbmnbomabfdbajlbpnacndeihl?color=blue&label=Chrome&style=flat-square&logo=google-chrome&logoColor=white" />
13+
</a>
614

7-
[Add to Chrome](https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl)
15+
<a href="https://microsoftedge.microsoft.com/addons/detail/logseq-copilot/ebigopegbohijaikegebaaboaomaifoi" target="_blank">
16+
<img alt="Microsoft Edge" src="https://img.shields.io/badge/Microsoft%20Edge-gray?style=flat-square&logo=microsoftedge">
17+
</a>
818

9-
[Add to Edge](https://microsoftedge.microsoft.com/addons/detail/logseq-copilot/ebigopegbohijaikegebaaboaomaifoi)
19+
<a href="https://addons.mozilla.org/en-US/firefox/addon/logseq-copilot/" target="_blank">
20+
<img alt="Firefox" src="https://img.shields.io/amo/stars/logseq-copilot?color=orange&label=Firefox&style=flat-square&logo=firefox&logoColor=white" />
21+
</a>
22+
</p>
1023

11-
[Add to Firefox](https://addons.mozilla.org/en-US/firefox/addon/logseq-copilot/)
24+
25+
Logseq Copilot is a Chrome extension that allows you to access your Logseq using your browser. Logseq is a privacy-first, open-source platform for knowledge sharing and management. With Logseq Copilot, you can easily retrieve relevant information from your Logseq graph and enrich your online search, reading, and learning experience. 🧠
1226

1327
## Features
1428

1529
- 🔍 Show Logseq content when you search on popular search engines via your keywords. Now support Google, Bing, Baidu, Yandex, DuckDuckGo, SearX.
1630

31+
## Support
32+
<p align="center">
33+
<a href="https://img.shields.io/github/sponsors/eindex" target="_blank">
34+
<img alt="GitHub Sponsors" src="https://img.shields.io/github/sponsors/eindex?style=flat-square&logo=github">
35+
</a>
36+
<a href="https://www.buymeacoffee.com/eindex" target="_blank">
37+
<img alt="Buy me a Coffee" src="https://img.shields.io/badge/Buy%20me%20a%20coffee-gray?style=flat-square&logo=buymeacoffee">
38+
</a>
39+
</p>
40+
1741
## Screenshot
1842

1943
![](docs/screenshots/screenshot.png)
@@ -33,20 +57,25 @@ How to use this extension, please follow the below steps:
3357

3458
![Starting Logseq API Server](docs/screenshots/start-api-server.png)
3559

36-
3. Setting Authorization tokens, for security reason, highly recommend setting this, If you want to connect with logseq copilot, must to setting this up.
60+
3. Setting Authorization token, for security reasons, highly recommend setting this, If you want to connect with Logseq copilot, must set this up.
3761

62+
**PS:** `Authorization token` is a secret string, you can set it as a random string you like.
3863
![Setting up Authorization Token](docs/screenshots/setting-auth-token.png)
64+
3965

40-
4. (Optional) Enable auto start server when Logseq lunched.
66+
4. Enable auto-start server when Logseq open.
4167

4268
![Enable Auto Start](docs/screenshots/enable-auto-start.png)
4369

4470
2. Install extension.
45-
- Store version(**Recommend**): [Chrome](https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl), [Edge](https://chrome.google.com/webstore/detail/logseq-copilot/ebigopegbohijaikegebaaboaomaifoi), [Firefox](https://addons.mozilla.org/en-US/firefox/addon/logseq-copilot/)
46-
- Newest Version [release page](https://github.com/EINDEX/logseq-copilot/releases) download it and load as unpacked.
71+
- Store version(**Recommend**): [Chrome](https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl), [Edge](https://microsoftedge.microsoft.com/addons/detail/logseq-copilot/ebigopegbohijaikegebaaboaomaifoi), [Firefox](https://addons.mozilla.org/en-US/firefox/addon/logseq-copilot/)
72+
- Newest Version [release page](https://github.com/EINDEX/logseq-copilot/releases) download it and load it as unpacked.
73+
74+
3. Go to Options page to set the connection.
75+
If you're setting it correctly, you will see a message show on your Logseq and options page will show connected.
76+
And your `Authorization token` will be used here agian.
77+
![Set Options](docs/screenshots/logseq-copilot-option.png)
4778

48-
3. Go to Options page to setting the connection.
49-
If you're setting correct, you will see a message show on your Logseq and options page will show connected.
5079

5180
4. You can use Logseq Copilot now!!
5281

@@ -73,9 +102,7 @@ Logseq Copilot is an open-source project and welcomes contributions from anyone
73102
- Create a new branch for your feature or bug fix. 🌿
74103
- Make your changes and commit them with a clear and concise message.
75104

76-
## Support
77105

78-
<a href="https://www.buymeacoffee.com/eindex"><img src="https://img.buymeacoffee.com/button-api/?text=Buy me a coffee&emoji=&slug=eindex&button_colour=40DCA5&font_colour=ffffff&font_family=Cookie&outline_colour=000000&coffee_colour=FFDD00" /></a>
79106

80107
## Credits
81108

69.7 KB
Loading

0 commit comments

Comments
 (0)