Skip to content

Commit d21439b

Browse files
committed
update readme
1 parent 923cec9 commit d21439b

6 files changed

Lines changed: 491 additions & 32 deletions

File tree

README.md

Lines changed: 37 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,40 @@
1-
# @codexteam/typescript-lib-template
2-
A quick start template for a new TypeScript library
3-
4-
[![NPM version](https://img.shields.io/npm/v/@codexteam/typescript-lib-template?style=flat-square)](https://www.npmjs.com/package/@codexteam/typescript-lib-template)
5-
[![License](https://img.shields.io/npm/l/@codexteam/typescript-lib-template?style=flat-square)](https://www.npmjs.com/package/@codexteam/typescript-lib-template)
6-
7-
## Features
8-
9-
- 💄 Yarn 4
10-
- 🛍️ Yarn Workspaces
11-
- 💎 ESLint 9 with [eslint-config-codex](http://github.com/codex-team/eslint-config/)
12-
- 🥃 Typescript 5
13-
- 🥊 npx only-allow yarn
14-
- 🌶️ Tests with [Vitest](https://vitest.dev)
15-
- 🍀 GitHub Actions for test/lint/build/publish purposes
16-
17-
## How to use
18-
1. Click [here](https://github.com/codex-team/typescript-lib-template/generate) and fill setting for new repository
19-
2. Update root package `package.json`, change main package name
20-
3. Update "core" package `package.json`:
21-
1. Change `name`
22-
2. Adjust `main`, `types`, `exports`
23-
5. Change name of `packages/core` to your main package name
24-
5. Go to `packages/utils` and adjust its name or remove the package if you don't need it
25-
3. Change NPM package scope from [workflow file](./.github/workflows/main.yml) or remove it
26-
4. Fill `NPM_TOKEN` and `CODEX_BOT_WEBHOOK` secrets in your repository or organization settings
27-
5. Start writing your new library!
28-
29-
# About CodeX
1+
# @hawk.so/kit
2+
3+
Set of packages for Hawk services development (monorepo).
4+
5+
## Packages
6+
7+
- **[@hawk.so/utils](./packages/utils)** — shared utilities for Hawk packages.
8+
- `hasValue` — check that a value is not `undefined`, `null`, or empty string.
9+
- `TimeMs` — enum of time intervals in milliseconds (Second, Minute, Hour, Day, Week).
10+
11+
- **[@hawk.so/github-sdk](./packages/github)** — GitHub API client for Hawk.
12+
- `GitHubService` — GitHub App (installation, installations, repositories).
13+
- Create and manage issues, assign Copilot to an issue.
14+
- OAuth: exchange code for token, refresh token, validate user token.
15+
- `normalizeGitHubPrivateKey` — normalize PEM key from env (base64, quotes, `\n`).
16+
- Types: `GitHubServiceConfig`, `OAuthTokens`, `GitHubUser`, `ValidateUserTokenResult`, `Repository`, `Installation`, `GitHubIssue`, `IssueData`.
17+
18+
## Requirements
19+
20+
- Node.js >= 22.0.0
21+
- Yarn 4 (Corepack enabled in repo)
22+
23+
## Commands
24+
25+
```bash
26+
yarn install # install dependencies
27+
yarn build # build all packages
28+
yarn lint # lint (build + eslint across packages)
29+
yarn test # run tests
30+
yarn clean # remove dist and tsbuildinfo
31+
```
32+
33+
## License
34+
35+
AGPL-3.0
36+
37+
## About CodeX
3038

3139
<img align="right" width="120" height="120" src="https://codex.so/public/app/img/codex-logo.svg" hspace="50">
3240

0 commit comments

Comments
 (0)