Skip to content

Commit

Permalink
Merge pull request #8 from HeesuKim0203/release/trivial
Browse files Browse the repository at this point in the history
Release/trivial
  • Loading branch information
HeesuKim0203 authored Jan 25, 2024
2 parents 6928027 + 477ed6b commit 2372a16
Show file tree
Hide file tree
Showing 4 changed files with 34 additions and 6 deletions.
36 changes: 32 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,13 +11,16 @@ Vivid Console is an ideal tool for those who want to add a splash of color to th

## Example

### Support
The basic 8 colors are supported as follows!
![Support](/scripts/public/support.png)

### Terminal
![console](/scripts/public/jsTest.PNG)

### Web console
![webconosle](/scripts/public/webConsoleTest.PNG)


## Getting Started
To start using Vivid Console, install the package using npm

Expand All @@ -28,22 +31,46 @@ npm install vivid-console
This library is compatible with various environments including JavaScript, TypeScript, and browsers, supporting both ES5 and ES6 standards.

### Font Color
The basic 8 colors.
```javascript
console.log(VC.color.red("test"))
console.log(VC.color.black("test"))
console.log(VC.color.red("test"))
console.log(VC.color.green("test"))
console.log(VC.color.yellow("test"))
console.log(VC.color.blue("test"))
console.log(VC.color.magenta("test"))
console.log(VC.color.cyan("test"))
console.log(VC.color.white("test"))
```

### Background Color
The basic 8 colors.
```javascript
console.log(VC.bg.black("test"))
console.log(VC.bg.red("test"))
console.log(VC.bg.green("test"))
console.log(VC.bg.yellow("test"))
console.log(VC.bg.blue("test"))
console.log(VC.bg.magenta("test"))
console.log(VC.bg.cyan("test"))
console.log(VC.bg.white("test"))
```

### Font Style
```javascript
console.log(VC.bold("test"))
console.log(VC.faint("test"))
console.log(VC.italic("test"))
console.log(VC.underline("test"))
console.log(VC.inverse("test"))
console.log(VC.hidden("test"))
console.log(VC.strike("test"))
```

### Custom color
You can enter the number of the color you want to use as the first argument.
You can enter the number of the color you want to use as the first argument.
<b>Web console is not supported!</b>
![](/scripts/public/customColor.png)
```javascript
console.log(VC.colorCustom(146, "test"))
Expand All @@ -52,8 +79,9 @@ console.log(VC.colorCustom(146, "test"))
console.log(VC.bgCustom(146, "test"))
```

### Custom web console color
For the web, enter css! Some unsupported css.
### Custom web console
Please insert your desired CSS as the first parameter.
<b>Only web console is supported!</b>
```javascript
VC.console("color : #999999 ; background : #000000 ;", "test")
```
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "vivid-console",
"version": "1.0.2",
"description": "The aim of this project is to enable developers to rapidly and efficiently deploy NPM public packages. This template is designed to allow users to create, manage, and distribute their NPM packages with minimal setup.",
"version": "1.0.3",
"description": "Vivid Console is an ideal tool for those who want to add a splash of color to their console outputs. It enables styling in both Terminal and Web Console environments, making your logs more visually appealing and easier to read.",
"types": "./lib/cjs/types/index.d.ts",
"main": "./lib/cjs/index.js",
"module": "./lib/esm/index.js",
Expand Down
Binary file modified scripts/public/customColor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added scripts/public/support.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2372a16

Please sign in to comment.