docs: update README, rename package

This commit is contained in:
Chen Asraf
2023-05-29 21:07:04 +03:00
parent ea5d3e5368
commit fd7b69d4f4
3 changed files with 48 additions and 7 deletions

41
README.md Normal file
View File

@@ -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 |

View File

@@ -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 <contact@casraf.dev>",
"license": "MIT",
"dependencies": {
"massarg": "1.0.7-pre.1",
"simple-scaffold": "^1.7.0"

View File

@@ -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) {