diff --git a/README.md b/README.md index ddb08d0..7d2fe7e 100755 --- a/README.md +++ b/README.md @@ -1,19 +1,43 @@ # Logseq Copilot 🚀 -[![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) +

+ + GPL-3.0 License + -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. 🧠 + + TypeScript + + + Chrome + -[Add to Chrome](https://chrome.google.com/webstore/detail/logseq-copilot/hihgfcgbmnbomabfdbajlbpnacndeihl) + + Microsoft Edge + -[Add to Edge](https://microsoftedge.microsoft.com/addons/detail/logseq-copilot/ebigopegbohijaikegebaaboaomaifoi) + + Firefox + +

-[Add to Firefox](https://addons.mozilla.org/en-US/firefox/addon/logseq-copilot/) + +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. 🧠 ## Features - 🔍 Show Logseq content when you search on popular search engines via your keywords. Now support Google, Bing, Baidu, Yandex, DuckDuckGo, SearX. +## Support +

+ + GitHub Sponsors + + + Buy me a Coffee + +

+ ## Screenshot ![](docs/screenshots/screenshot.png) @@ -33,20 +57,25 @@ How to use this extension, please follow the below steps: ![Starting Logseq API Server](docs/screenshots/start-api-server.png) - 3. Setting Authorization tokens, for security reason, highly recommend setting this, If you want to connect with logseq copilot, must to setting this up. + 3. Setting Authorization token, for security reasons, highly recommend setting this, If you want to connect with Logseq copilot, must set this up. + **PS:** `Authorization token` is a secret string, you can set it as a random string you like. ![Setting up Authorization Token](docs/screenshots/setting-auth-token.png) + - 4. (Optional) Enable auto start server when Logseq lunched. + 4. Enable auto-start server when Logseq open. ![Enable Auto Start](docs/screenshots/enable-auto-start.png) 2. Install extension. - - 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/) - - Newest Version [release page](https://github.com/EINDEX/logseq-copilot/releases) download it and load as unpacked. + - 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/) + - Newest Version [release page](https://github.com/EINDEX/logseq-copilot/releases) download it and load it as unpacked. + +3. Go to Options page to set the connection. + If you're setting it correctly, you will see a message show on your Logseq and options page will show connected. + And your `Authorization token` will be used here agian. + ![Set Options](docs/screenshots/logseq-copilot-option.png) -3. Go to Options page to setting the connection. - If you're setting correct, you will see a message show on your Logseq and options page will show connected. 4. You can use Logseq Copilot now!! @@ -73,9 +102,7 @@ Logseq Copilot is an open-source project and welcomes contributions from anyone - Create a new branch for your feature or bug fix. 🌿 - Make your changes and commit them with a clear and concise message. -## Support - ## Credits diff --git a/docs/screenshots/logseq-copilot-option.png b/docs/screenshots/logseq-copilot-option.png new file mode 100644 index 0000000..beb102b Binary files /dev/null and b/docs/screenshots/logseq-copilot-option.png differ