Add .npmignore, LICENSE.txt, and update README.md

- Created a .npmignore file to exclude unnecessary files and directories from npm packages. - Added LICENSE.txt to specify the licensing terms for the project. - Expanded README.md to include detailed plugin features, installation instructions, usage guidelines, and contribution information. - Updated package.json to reflect new repository URLs for issues and homepage.
2026-02-05 22:31:20 +00:00
parent d387c7bf8a
commit 08dac92ead
5 changed files with 204 additions and 4 deletions
--- a/.gitea/workflows/publish.yml
+++ b/.gitea/workflows/publish.yml
@@ -0,0 +1,75 @@
+name: Publish
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  test:
+    name: Tests
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: "npm"
+          cache-dependency-path: |
+            package-lock.json
+            playground/package-lock.json
+      - name: Write playground .env
+        run: |
+          printf '%s' "${{ secrets.PLAYGROUND_ENV_BASE64 }}" | base64 -d > playground/.env
+      - name: Install root deps
+        run: npm ci
+      - name: Build plugin
+        run: npm run build
+      - name: Verify plugin
+        run: npm run verify
+      - name: Pack plugin into playground .yalc
+        run: |
+          TARBALL=$(npm pack --silent)
+          mkdir -p playground/.yalc/strapi-plugin-checkbox-list
+          tar -xzf "$TARBALL" -C playground/.yalc/strapi-plugin-checkbox-list --strip-components=1
+      - name: Install playground deps
+        working-directory: playground
+        run: npm install
+      - name: Build playground
+        working-directory: playground
+        run: npm run build
+      - name: Integration tests
+        working-directory: playground
+        run: npm run test:integration
+
+  publish:
+    name: Publish to NPM
+    runs-on: ubuntu-latest
+    needs: test
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          registry-url: https://registry.npmjs.org/
+          cache: "npm"
+          cache-dependency-path: package-lock.json
+      - name: Install deps
+        run: npm ci
+      - name: Clean build artifacts
+        run: rm -rf dist
+      - name: Build plugin
+        run: npm run build
+      - name: Verify plugin
+        run: npm run verify
+      - name: Clean workspace for publish
+        run: |
+          rm -rf playground tests admin server node_modules .gitea .github
+      - name: Publish
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
--- a/.npmignore
+++ b/.npmignore
@@ -0,0 +1,39 @@
+# Dependencies and logs
+node_modules/
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+pnpm-debug.log*
+
+# Caches and temp
+.cache/
+.tmp/
+*.tgz
+
+# VCS / CI / IDE
+.git/
+.gitea/
+.github/
+.gitlab/
+.vscode/
+.idea/
+.DS_Store
+
+# Playground / tests / coverage
+playground/
+tests/
+coverage/
+**/__tests__/
+**/*.spec.*
+**/*.test.*
+
+# Source-only folders (built output lives in dist/)
+admin/
+server/
+
+# Misc project files
+renovate.config.cjs
+package-lock.json
+.env
+.env.*
--- a/LICENSE.txt
+++ b/LICENSE.txt
@@ -0,0 +1,7 @@
+Copyright (c) 2026 Valentin Popov <valentin@popov.link>
+
+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.
--- a/README.md
+++ b/README.md
@@ -1 +1,80 @@
-# strapi-plugin-checkbox-list
+# Strapi Checkbox List Plugin
+
+A custom field plugin for Strapi v5 that extends the Content Type Builder with a flexible checkbox list component. Enable content editors to select multiple values from predefined options with an intuitive interface that seamlessly integrates into the Strapi admin panel.
+
+## Features
+
+- **Multi-select interface**: Intuitive checkbox-based selection for content editors
+- **Flexible configuration**: Define custom option lists for each field instance
+- **Native integration**: Works seamlessly within Strapi's Content Type Builder
+- **Type-safe**: Full TypeScript support for enhanced development experience
+
+## Requirements
+
+- Node.js and npm compatible with Strapi v5
+- Strapi `@strapi/strapi` ^5.35.0
+
+## Installation
+
+Install the package in your Strapi project:
+
+```bash
+npm install strapi-plugin-checkbox-list
+```
+
+Restart your Strapi application, then navigate to the Content Type Builder to add the **Checkbox list** custom field to your content types.
+
+## Usage
+
+After installation, the Checkbox list field type will be available in the Content Type Builder:
+
+1. Open Content Type Builder
+2. Select a content type or create a new one
+3. Click "Add another field"
+4. Choose "Checkbox list" from the custom fields
+5. Configure your checkbox options
+6. Save and use in your content entries
+
+## Contributing & Support
+
+This project is actively maintained and welcomes contributions. Issues and pull requests can be submitted through either repository:
+
+- **Primary development**: [valentineus/strapi-plugin-checkbox-list](https://code.popov.link/valentineus/strapi-plugin-checkbox-list/issues)
+- **GitHub mirror**: [valentineus/strapi-plugin-checkbox-list](https://github.com/valentineus/strapi-plugin-checkbox-list/issues)
+
+Development primarily takes place on the self-hosted Git instance, with GitHub serving as a mirror for broader accessibility.
+
+**Maintainer**: Valentin Popov <valentin@popov.link>
+
+## Development
+
+Build the plugin:
+
+```bash
+npm install
+npm run build
+```
+
+For active development with automatic rebuilds:
+
+```bash
+npm run watch
+```
+
+To run the test Strapi app from `playground/`:
+
+```bash
+cd playground
+npm install
+npm run develop
+```
+
+If you need the plugin linked into the playground app, use the Strapi plugin linker and point it at `playground/`:
+
+```bash
+npm run watch:link
+```
+
+## License
+
+This project is licensed under the [MIT License](LICENSE.txt).
--- a/package.json
+++ b/package.json
@@ -69,11 +69,11 @@
  "license": "MIT",
  "repository": {
    "type": "git",
-    "url": "git+ssh://git@popov.link/valentineus/strapi-plugin-checkbox-list.git"
+    "url": "git+ssh://git@code.popov.link/valentineus/strapi-plugin-checkbox-list.git"
  },
  "bugs": {
-    "url": "https://popov.link/valentineus/strapi-plugin-checkbox-list/issues"
+    "url": "https://code.popov.link/valentineus/strapi-plugin-checkbox-list/issues"
  },
-  "homepage": "https://popov.link/valentineus/strapi-plugin-checkbox-list#readme",
+  "homepage": "https://code.popov.link/valentineus/strapi-plugin-checkbox-list#readme",
  "author": "Valentin Popov <valentin@popov.link>"
 }