diff --git a/README.md b/README.md new file mode 100644 index 0000000..96e3d45 --- /dev/null +++ b/README.md @@ -0,0 +1,41 @@ +# licenseg + +Generate license for your projects easily. + +## How to use + +No need to install. Just use `npx`! + +```shell +npx licenseg --name "My Name" mit +``` + +Or install globally: + +```shell +# with your favorite package manager +pnpm add -g licenceg +yarn global add licenceg +pnpm i -g licenceg + +# then use +licenceg --name "My Name" mit +``` + +## Commands + +See the commands at any time by using `npx licenceg -h`. + +| Command | Description | +| ----------------- | -------------------------- | +| list \| ls | Lists available licenses | +| clear-cache \| cc | Clears the cache directory | +| preview \| p | Preview a license | + +Options: + +| Option | Description | +| ------------- | ------------------------ | +| --help\|-h | Display help information | +| --name\|-n | Your name | +| --license\|-l | License to generate | diff --git a/package.json b/package.json index c96f42f..b957cd9 100644 --- a/package.json +++ b/package.json @@ -1,14 +1,14 @@ { - "name": "license-gen", - "version": "1.0.0", - "description": "", - "main": "index.js", + "name": "licenseg", + "version": "0.1.0", + "description": "Generate LICENSE files for your projects", + "main": "index.mjs", "scripts": { "test": "echo \"Error: no test specified\" && exit 1" }, "keywords": [], - "author": "", - "license": "ISC", + "author": "Chen Asraf ", + "license": "MIT", "dependencies": { "massarg": "1.0.7-pre.1", "simple-scaffold": "^1.7.0" diff --git a/utils.mjs b/utils.mjs index fee0173..818631e 100644 --- a/utils.mjs +++ b/utils.mjs @@ -3,7 +3,7 @@ import * as path from 'path' import { exec } from 'child_process' import { promisify } from 'util' -export const CACHE_DIR = process.env.HOME + '/.cache/license-gen' +export const CACHE_DIR = process.env.HOME + '/.cache/licenseg' const execAsync = promisify(exec) export async function exists(f) {