Update Readme

This commit is contained in:
ittuann 2023-10-18 18:05:25 +08:00 committed by GitHub
parent f38c8a4823
commit 9c9c438dc4
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 14 additions and 33 deletions

View file

@ -1,28 +0,0 @@
name: FOSSA
on:
push:
branches:
- master
release:
types: [created]
jobs:
analysis:
runs-on: ubuntu-latest
environment: staging
strategy:
fail-fast: false
steps:
- name: Checkout Code
uses: actions/checkout@v4
with:
ref: ${{ github.head_ref }}
fetch-depth: 0
- name: Run FOSSA Scan
uses: fossas/fossa-action@v1.3.1
with:
api-key: ${{ secrets.FOSSA_API }}

View file

@ -7,7 +7,6 @@
[![TAG][tag-image]][tag-url]
[![Downloads][downloads-image]][downloads-url]
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin.svg?type=shield)](https://app.fossa.com/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin?ref=badge_shield)
[ci-image]: https://img.shields.io/github/actions/workflow/status/ittuann/obsidian-gpt-liteinquirer-plugin/CI.yml?branch=master&label=Build%20Status&logo=github&style=for-the-badge
[ci-url]: https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin
@ -30,7 +29,7 @@ With this GPT-LiteInquirer Plugin, you can quickly and senselessly generate idea
The Lightweight ChatGPT Plugin is a fast, easy-to-use, and non-intrusive AI assistant plugin, which senselessly integrates OpenAI's ChatGPT API directly into Obsidian.
If you enjoy this plugin or would like to show your support, please consider giving it a free star on GitHub~
If you enjoy this plugin or would like to show your support, please consider giving it a free [Star ✨](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin) on GitHub~
**Install and view this plugin automatically within Obsidian: [Click here](https://obsidian.md/plugins?id=gpt-liteinquirer)**
@ -57,7 +56,8 @@ If you enjoy this plugin or would like to show your support, please consider giv
## 🧩 Configuration
You **MUST** need to set your own OpenAI API key in the Plugin Settings first, so that the plugin can work properly.
> [!IMPORTANT]
> You must need to set your own OpenAI API key in the Plugin Settings first, so that the plugin can work properly.
1. Generate an OpenAI API key on the official website. [Click here](https://beta.openai.com/account/api-keys)
2. In Obsidian, go to `Settings`, click `Community Plugins` in the left menu , and enable `GPT-LiteInquirer` in the Installed Plugins.
@ -92,4 +92,4 @@ GPT-LiteInquirer Plugin for Obsidian wants to be a nice companion to boost your
The project is [MIT Licensed](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/blob/master/LICENSE).
[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin?ref=badge_large&issueType=license)
[![FOSSA License Compliance Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin?ref=badge_large&issueType=license)

View file

@ -5,6 +5,7 @@
[![CI][ci-image]][ci-url]
[![Code Scanning][code-scanning-image]][code-scanning-url]
[![TAG][tag-image]][tag-url]
[![Downloads][downloads-image]][downloads-url]
[ci-image]: https://img.shields.io/github/actions/workflow/status/ittuann/obsidian-gpt-liteinquirer-plugin/CI.yml?branch=master&label=Build%20Status&logo=github&style=for-the-badge
@ -55,7 +56,8 @@ Language:
## 🧩 配置
您需要先在插件设置中设置自己的 OpenAI API 密钥,以便插件可以正常工作。
> [!IMPORTANT]
> 您需要先在插件设置中设置自己的 OpenAI API 密钥,以便插件可以正常工作。
1. 在官方网站上生成 OpenAI API 密钥。[点击这里](https://beta.openai.com/account/api-keys)
2. 在 Obsidian 中,转到`设置`,在左侧菜单中单击`社区插件`,然后启用已经安装好的`GPT-LiteInquirer`插件。
@ -76,3 +78,10 @@ Language:
提示:您也可以使用 `CTRL + ENTER` 快捷键直接发送内容。
GPT-LiteInquirer 插件旨在成为提高您创造力和生产力的小工具。今天就在 Obsidian 中体验无缝的 AI 增强写作和内容生成能力吧!
## License
The project is [MIT Licensed](https://github.com/ittuann/obsidian-gpt-liteinquirer-plugin/blob/master/LICENSE).
[![FOSSA License Compliance Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin.svg?type=large&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fittuann%2Fobsidian-gpt-liteinquirer-plugin?ref=badge_large&issueType=license)