diff --git a/README.md b/README.md index dfe92ac2..8923c02a 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,42 @@ -## DVLA Usage +# DVLA Usage This is a fork of [OpenCommit](https://github.com/di-sukharev/opencommit). - It includes functionality to use Azure OpenAPI service as a backend originating from this [pull request](https://github.com/di-sukharev/opencommit/pull/167). - The package has been renamed to `@dvla/opencommit` for internal use. - The MIT License still applies and references the contribution from the original author `Dima Sukharev`. -  -  +## Quickstart + +1) Create a file `~/.opencommit` with the following contents: +``` +OCO_OPENAI_API_KEY= +OCO_OPENAI_BASE_PATH= +OCO_OPENAI_API_TYPE=azure +OCO_AZURE_DEPLOYMENT=turbo-613 +OCO_AZURE_API_VERSION=2023-07-01-preview +OCO_ISSUE_ENABLED=true +OCO_ISSUE_PREFIX=ET- +``` + +2) Download the latest release .tgz file from [OpenCommit Releases](https://github.com/dvla/opencommit/releases) + +3) Install OpenCommit globally to use in any repository using the latest release file: +``` + npm install -g /PATH-TO-FILE +``` +4) You can then call OpenCommit directly to generate a commit message for your staged changes in your project: + +```sh +git add +opencommit +``` + +You can also use the `oco` shortcut: + +```sh +git add +oco +``` +     @@ -98,7 +129,7 @@ OCO_MODEL= OCO_OPENAI_BASE_PATH= OCO_AZURE_DEPLOYMENT= diff --git a/package-lock.json b/package-lock.json index f3865aea..e265b070 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@dvla/opencommit", - "version": "1.0.0-alpha", + "version": "1.0.0-beta", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@dvla/opencommit", - "version": "1.0.0-alpha", + "version": "1.0.0-beta", "license": "MIT", "dependencies": { "@actions/core": "^1.10.0", diff --git a/package.json b/package.json index dbe99a60..e33afaf7 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@dvla/opencommit", - "version": "1.0.0-alpha", + "version": "1.0.0-beta", "description": "Auto-generate impressive commits in 1 second. Killing lame commits with AI 🤯🔫", "keywords": [ "git",