docs(README): reorganize and update installation steps

- Combine global and local installation steps
- Update supported generator list
- Fix ERNIE Bot to ERNIE

Author: guanguans

.phpstorm.meta.php

@@ -14,6 +14,7 @@
 
 use Illuminate\Bus\Dispatcher;
 use Illuminate\Config\Repository;
+use Illuminate\Container\Container as IlluminateContainer;
 use Illuminate\Contracts\Container\Container;
 use Illuminate\Database\DatabaseManager;
 use Illuminate\Support\Arr;
@@ -28,42 +29,34 @@
     'view.finder' => FileViewFinder::class,
     'config' => Repository::class,
 ]));
-
-override((new \Illuminate\Container\Container())->makeWith(0), map([
+override((new IlluminateContainer())->makeWith(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override((new Container())->get(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override((new Container())->make(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override(Container::makeWith(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override(\App::get(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override(\App::make(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override(\App::makeWith(0), map([
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override(app(0), map([
     '' => '@',
     'config' => Repository::class,
@@ -72,7 +65,6 @@
     '' => '@',
     'config' => Repository::class,
 ]));
-
 override((new ContainerInterface())->get(0), map([
     '' => '@',
     'config' => Repository::class,

README-zh_CN.md

@@ -16,10 +16,10 @@
 
 ## 支持
 
+- [x] [Bito](https://github.com/gitbito/CLI)
 - [x] [OpenAI Chat](https://platform.openai.com/docs/api-reference/chat)
 - [x] [OpenAI](https://platform.openai.com/docs/api-reference/completions)
-- [x] [Bito](https://github.com/gitbito/CLI)
-- [ ] [ERNIE Bot](https://yiyan.baidu.com/welcome)
+- [ ] [ERNIE](https://yiyan.baidu.com/welcome)
 - [ ] ...
 
 ## 环境要求
@@ -38,24 +38,20 @@ chmod +x ai-commit
 ### 通过 Composer 安装
 
 ```shell
-# 全局
-composer global require guanguans/ai-commit --dev -v
-
-# 本地
-composer require guanguans/ai-commit --dev -v
+composer global require guanguans/ai-commit --dev -v # 全局
+composer require guanguans/ai-commit --dev -v # 本地
 ```
 
 ## 使用
 
 ### 快速开始
 
 ```shell
-./ai-commit config set generators.openaichat.api_key sk-... --global # 配置 OpenAI API key
-./ai-commit config set generators.openai.api_key sk-... --global # 配置 OpenAI API key
 ./ai-commit config set generators.bito.path bito-path... --global # 配置 Bito 路径(可选)
+./ai-commit config set generators.openai.api_key sk-... --global # 配置 OpenAI API key
+./ai-commit config set generators.openaichat.api_key sk-... --global # 配置 OpenAI API key
 
-# 生成且提交信息
-./ai-commit commit
+./ai-commit commit # 生成且提交信息
 ```
 
 ```shell

README.md

@@ -16,10 +16,10 @@
 
 ## Support
 
+- [x] [Bito](https://github.com/gitbito/CLI)
 - [x] [OpenAI Chat](https://platform.openai.com/docs/api-reference/chat)
 - [x] [OpenAI](https://platform.openai.com/docs/api-reference/completions)
-- [x] [Bito](https://github.com/gitbito/CLI)
-- [ ] [ERNIE Bot](https://yiyan.baidu.com/welcome)
+- [ ] [ERNIE](https://yiyan.baidu.com/welcome)
 - [ ] ...
 
 ## Requirement
@@ -38,24 +38,20 @@ chmod +x ai-commit
 ### Install via Composer
 
 ```shell
-# global
-composer global require guanguans/ai-commit --dev -v
-
-# local
-composer require guanguans/ai-commit --dev -v
+composer global require guanguans/ai-commit --dev -v # global
+composer require guanguans/ai-commit --dev -v # local
 ```
 
 ## Usage
 
 ### Quick start
 
 ```shell
-./ai-commit config set generators.openaichat.api_key sk-... --global # Config OpenAI API key
-./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
 ./ai-commit config set generators.bito.path bito-path... --global # Config Bito path(Optional)
+./ai-commit config set generators.openai.api_key sk-... --global # Config OpenAI API key
+./ai-commit config set generators.openaichat.api_key sk-... --global # Config OpenAI API key
 
-# Generate and commit message
-./ai-commit commit
+./ai-commit commit # Generate and commit message
 ```
 
 ```shell

config/ai-commit.php

@@ -56,60 +56,60 @@
 
     // The list of generators.
     'generators' => [
-        'openaichat' => [
-            'driver' => 'openai',
-            'http_options' => [
-                // guzzlehttp\requestoptions::proxy => 'https://proxy.com/v1',
+        'bito' => [
+            'driver' => 'bito',
+            'path' => null,
+            'prompt_filename' => 'bito.prompt',
+            'parameters' => [
+                'cwd' => null,
+                'env' => null,
+                'input' => null,
+                'timeout' => 120,
             ],
+        ],
+        'openai' => [
+            'driver' => 'openai',
             'api_key' => env('OPENAI_API_KEY', 'sk-...'),
             'parameters' => [
-                'model' => 'gpt-3.5-turbo', // 'gpt-4,gpt-4-0613,gpt-4-32k,gpt-4-32k-0613,gpt-3.5-turbo,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo-16k-0613
-                // 'messages' => 'required|array',
+                'model' => 'text-davinci-003', // text-davinci-003,text-davinci-002,text-curie-001,text-babbage-001,text-ada-001
+                // 'prompt' => 'string|array',
+                'suffix' => null,
                 'max_tokens' => 600,
                 'temperature' => 0.0,
                 'top_p' => 1.0,
                 'n' => 1,
                 'stream' => true,
+                'logprobs' => null,
+                'echo' => false,
                 'stop' => null,
                 'presence_penalty' => 0,
                 'frequency_penalty' => 0,
+                'best_of' => 1,
                 // 'logit_bias' => null,
                 'user' => Illuminate\Support\Str::uuid()->toString(),
             ],
         ],
-        'openai' => [
+        'openaichat' => [
             'driver' => 'openai',
+            'http_options' => [
+                // guzzlehttp\requestoptions::proxy => 'https://proxy.com/v1',
+            ],
             'api_key' => env('OPENAI_API_KEY', 'sk-...'),
             'parameters' => [
-                'model' => 'text-davinci-003', // text-davinci-003,text-davinci-002,text-curie-001,text-babbage-001,text-ada-001
-                // 'prompt' => 'string|array',
-                'suffix' => null,
+                'model' => 'gpt-3.5-turbo', // 'gpt-4,gpt-4-0613,gpt-4-32k,gpt-4-32k-0613,gpt-3.5-turbo,gpt-3.5-turbo-0613,gpt-3.5-turbo-16k,gpt-3.5-turbo-16k-0613
+                // 'messages' => 'required|array',
                 'max_tokens' => 600,
                 'temperature' => 0.0,
                 'top_p' => 1.0,
                 'n' => 1,
                 'stream' => true,
-                'logprobs' => null,
-                'echo' => false,
                 'stop' => null,
                 'presence_penalty' => 0,
                 'frequency_penalty' => 0,
-                'best_of' => 1,
                 // 'logit_bias' => null,
                 'user' => Illuminate\Support\Str::uuid()->toString(),
             ],
         ],
-        'bito' => [
-            'driver' => 'bito',
-            'path' => null,
-            'prompt_filename' => 'bito.prompt',
-            'parameters' => [
-                'cwd' => null,
-                'env' => null,
-                'input' => null,
-                'timeout' => 120,
-            ],
-        ],
     ],
 
     /**