diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml new file mode 100644 index 0000000..b998996 --- /dev/null +++ b/.github/workflows/publish.yml @@ -0,0 +1,22 @@ +name: Publish to npm + +on: + push: + tags: + - "v*" + +jobs: + publish: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + + - uses: oven-sh/setup-bun@v2 + with: + bun-version: latest + + - run: bun install + + - run: npm publish + env: + NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..2ead81a --- /dev/null +++ b/.npmignore @@ -0,0 +1,9 @@ +site/ +docs/ +tmp/ +assets/ +node_modules/ +*.lock +.claude/ +CLAUDE.md +human-mouse.js diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..b71dd3a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2025 alezmad + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index 0a42943..7ea7137 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,22 @@ Requires [Bun](https://bun.sh) >= 1.3.0 and macOS (uses Terminal.app for launching). ```bash -# Clone and install +# Install globally +bun install -g cladm + +# Or run directly +bunx cladm +``` + +### From source (for development) + +```bash git clone https://github.com/alezmad/cladm.git cd cladm bun install - -# Register the `cladm` command globally bun link ``` -Now you can run `cladm` from anywhere. - ## Usage ```bash diff --git a/package.json b/package.json index a7b8b08..81cd932 100644 --- a/package.json +++ b/package.json @@ -7,8 +7,21 @@ "bin": { "cladm": "src/index.ts" }, + "files": [ + "src/", + "README.md", + "LICENSE" + ], "keywords": ["claude", "claude-code", "tui", "terminal", "launcher", "bun"], "license": "MIT", + "author": "alezmad", + "repository": { + "type": "git", + "url": "https://github.com/alezmad/cladm.git" + }, + "engines": { + "bun": ">=1.3.0" + }, "devDependencies": { "@types/bun": "latest" },