Skip to content

Commit

Permalink
Merge branch 'main' of https://github.com/phukon/openlgen
Browse files Browse the repository at this point in the history
  • Loading branch information
phukon committed Dec 4, 2023
2 parents 5bc449b + cc4e85c commit 6bd488d
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 14 deletions.
35 changes: 21 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,23 @@
# Openlgen
![GitHub release (with filter)](https://img.shields.io/github/v/release/phukon/ligen)
![GitHub all releases](https://img.shields.io/github/downloads/phukon/ligen/total)
![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/phukon/ligen)
![GitHub release (with filter)](https://img.shields.io/github/v/release/phukon/openlgen)
![GitHub Release Date - Published_At](https://img.shields.io/github/release-date/phukon/openlgen)


Blazing fast ⚡, command line license generator in Node.js. for your open source projects.<br/>
To learn more about licenses, see [choosealicense.com](choosealicense.com).

![Code_CxPbFb5ZXF](https://github.com/phukon/ligen/assets/60285613/48a617c9-81fe-4af3-bb50-fc947e89e92b)
## Installation
**⚠ This package requires global installation.**
```
$ npm install -g openlgen
```
**or use it by invoking**
```
$ npx openlgen
```

![Code_1VpZym2T1L](https://github.com/phukon/openlgen/assets/60285613/03842a17-b5b1-4439-b038-50440ff73532)


## Features

Expand All @@ -19,25 +29,22 @@ To learn more about licenses, see [choosealicense.com](choosealicense.com).

----------

## Installation and Usage (CLI)

```
$ npm install openlgen --save-dev
```

Usage
--------------

Generate a license automatically from package.json

Generate a license using the menu
```bash
openlgen-auto
$ openlgen
```
Generate a license using the menu

Generate a license automatically from package.json

```bash
openlgen
$ openlgen-auto
```


Available licenses
--------------
```
Expand Down
5 changes: 5 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
"description": "Effortless License Generation for Developers.",
"main": "index.js",
"type": "module",
"repository": {
"type": "git",
"url": "https://github.com/phukon/openlgen"
},
"homepage": "https://github.com/phukon/openlgen#readme",
"bin": {
"openlgen-auto": "./bin/index.js",
"openlgen": "./src/generate/buffer.js"
Expand Down

0 comments on commit 6bd488d

Please sign in to comment.