UNPKG

aimless-security

Version:

Enhanced Runtime Application Self-Protection (RASP) and API Fuzzing Engine with advanced threat detection, behavioral analysis, and intelligent response scoring for Node.js applications

134 lines (95 loc) 2.84 kB
# Alternative Distribution Methods Since NPM publishing is blocked, here are several ways to distribute **aimless-security**: ## 🚀 Option 1: GitHub Packages (Recommended) GitHub has its own package registry. Users can install directly from GitHub: ### Setup: 1. Already have GitHub repo 2. Update package name in `package.json` to include scope: ```json "name": "@camozdevelopment/aimless-security" ``` 3. Create `.npmrc` in project root: ``` @camozdevelopment:registry=https://npm.pkg.github.com ``` 4. Publish to GitHub Packages: ```bash npm publish ``` ### Users install with: ```bash npm install @camozdevelopment/aimless-security ``` --- ## 📦 Option 2: Direct GitHub Install (Easiest) Users can install directly from your GitHub repo: ### Users install with: ```bash npm install CamozDevelopment/Aimless-Security ``` Or specific version/tag: ```bash npm install CamozDevelopment/Aimless-Security#v1.3.1 ``` **No setup needed** - works right now! --- ## 🔗 Option 3: CDN Distribution (jsDelivr) Automatically serves files from GitHub releases: ### Users can use via CDN: ```html <!-- Browser --> <script src="https://cdn.jsdelivr.net/gh/CamozDevelopment/Aimless-Security@1.3.1/dist/index.js"></script> ``` ```javascript // Node.js - still use GitHub install npm install CamozDevelopment/Aimless-Security ``` --- ## 📥 Option 4: Release Assets (Manual Download) Create GitHub releases with built packages: 1. Tag version: `git tag v1.3.1 && git push origin v1.3.1` 2. GitHub Actions auto-creates release 3. Users download `.tgz` file and install: ```bash npm install ./aimless-security-1.3.1.tgz ``` --- ## 🎯 Recommended Approach **Use Option 2 (Direct GitHub Install)** - It's the simplest: ### Update README installation: ```markdown ## Installation ```bash npm install CamozDevelopment/Aimless-Security ``` Or install a specific version: ```bash npm install CamozDevelopment/Aimless-Security#v1.3.1 ``` \``` ### Usage stays the same: ```javascript const { Aimless } = require('aimless-security'); // or import Aimless from 'aimless-security'; ``` --- ## ✅ What to Do Now 1. **Tag current version:** ```bash git tag v1.3.1 git push origin v1.3.1 ``` 2. **Update README** with GitHub installation instructions 3. **Test installation:** ```bash cd ../test-project npm install CamozDevelopment/Aimless-Security ``` --- ## 🔄 Alternative: Setup GitHub Actions for GitHub Packages If you want to use GitHub Packages instead, I can: 1. Update package.json with scoped name 2. Create publish workflow for GitHub Packages 3. Add authentication instructions **Which option do you prefer?**