Skip to content

feat: add package download steps and update dependencies in project c… #15

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

feat: add package download steps and update dependencies in project c… #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ Before you begin, ensure that you have the following software installed on your

## Installation Steps

### Downloading the package

1. Add a package to your project:
```
pnpm add github:alismx/gitmsg#0.0.2
```

### Clone the repository

1. Clone the repository:
```
git clone https://github.com/alismx/gitmsg.git
Expand All @@ -33,7 +42,7 @@ Before you begin, ensure that you have the following software installed on your
```
This command compiles the TypeScript code into JavaScript.

5. Add `/usr/local/bin/gitmsg` file with contents:
5. Add `~/bin/gitmsg` file with contents:

```
#!/bin/sh
Expand Down
11 changes: 6 additions & 5 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,15 @@
"description": "Use openai to generate commit messages from a diff",
"main": "index.js",
"devDependencies": {
"prettier": "^2.8.8"
"prettier": "^2.8.8",
"@alismx/gitmsg": "github:alismx/gitmsg#0.0.2"
},
"dependencies": {
"openai": "^4.82.0",
"minimist": "^1.2.8",
"typescript": "^5.7.3",
"@types/minimist": "^1.2.5",
"@types/node": "^18.19.74",
"@types/minimist": "^1.2.5"
"minimist": "^1.2.8",
"openai": "^4.82.0",
"typescript": "^5.7.3"
},
"scripts": {
"build": "npx tsc",
Expand Down
19 changes: 19 additions & 0 deletions pnpm-lock.yaml
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.