Skip to content

Commit 0556eec

Browse files
ReySunReySun
committed
updata readme.md
1 parent c132be7 commit 0556eec

File tree

5 files changed

+113
-8
lines changed

5 files changed

+113
-8
lines changed

‎README.md‎

Lines changed: 53 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,57 @@
11
## Console-In-Dom
2+
``` bash
3+
npm install console-in-dom --save
4+
```
5+
[live-preview](https://reysun.github.io/console-in-dom/) here
26

3-
### Basic TYPE Screenshot
4-
![](screenshots/ui_basic_01.png)
7+
### how to use
8+
#### es2015
9+
``` javascript
10+
import { ConsoleInDom } from 'console-in-dom';
11+
let Console = ConsoleInDom.render(); //default render to document.body
12+
Console.log(1);
13+
console.log(1);
14+
/*
15+
let Console = ConsoleInDom.render(
16+
document.getElementById('output-console')
17+
);
18+
Console.log(1);
19+
console.log(1);
20+
*/
21+
```
522

6-
### Array TYPE Screenshot
7-
![](screenshots/ui_array_02.png)
23+
#### commonJS
24+
``` javascript
25+
let Console = require('console-in-dom').render();
26+
/*
27+
let Console = require('console-in-dom').render(
28+
document.getElementById('output-console')
29+
);
30+
Console.log(1);
31+
console.log(1);
32+
*/
33+
```
834

9-
### Object TYPE Screenshot
10-
![](screenshots/ui_object_02.png)
35+
#### unpkg
36+
[https://unpkg.com/console-in-dom@1.0.1/console.min.js](https://unpkg.com/console-in-dom@1.0.1/console.min.js)
37+
``` html
38+
<!DOCTYPE html>
39+
<html lang="en">
40+
<head>
41+
<meta charset="UTF-8">
42+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
43+
<meta http-equiv="X-UA-Compatible" content="ie=edge">
44+
<link rel="stylesheet" href="https://unpkg.com/console-in-dom@1.0.1/console.css">
45+
<title>console-in-dom</title>
46+
</head>
47+
<body>
48+
<div id="console_output"></div>
49+
<script src="https://unpkg.com/console-in-dom@1.0.1/console.min.js"></script>
50+
<script>
51+
var Console = ConsoleInDom.render();
52+
Console.log(1);
53+
console.log(1);
54+
</script>
55+
</body>
56+
</html>
57+
```

‎dist/package/README.md‎

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
## Console-In-Dom
2+
``` bash
3+
npm install console-in-dom --save
4+
```
5+
[live-preview](https://reysun.github.io/console-in-dom/) here
6+
7+
### how to use
8+
#### es2015
9+
``` javascript
10+
import { ConsoleInDom } from 'console-in-dom';
11+
let Console = ConsoleInDom.render(); //default render to document.body
12+
Console.log(1);
13+
console.log(1);
14+
/*
15+
let Console = ConsoleInDom.render(
16+
document.getElementById('output-console')
17+
);
18+
Console.log(1);
19+
console.log(1);
20+
*/
21+
```
22+
23+
#### commonJS
24+
``` javascript
25+
let Console = require('console-in-dom').render();
26+
/*
27+
let Console = require('console-in-dom').render(
28+
document.getElementById('output-console')
29+
);
30+
Console.log(1);
31+
console.log(1);
32+
*/
33+
```
34+
35+
#### unpkg
36+
[https://unpkg.com/console-in-dom@1.0.1/console.min.js](https://unpkg.com/console-in-dom@1.0.1/console.min.js)
37+
``` html
38+
<!DOCTYPE html>
39+
<html lang="en">
40+
<head>
41+
<meta charset="UTF-8">
42+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
43+
<meta http-equiv="X-UA-Compatible" content="ie=edge">
44+
<link rel="stylesheet" href="https://unpkg.com/console-in-dom@1.0.1/console.css">
45+
<title>console-in-dom</title>
46+
</head>
47+
<body>
48+
<div id="console_output"></div>
49+
<script src="https://unpkg.com/console-in-dom@1.0.1/console.min.js"></script>
50+
<script>
51+
var Console = ConsoleInDom.render();
52+
Console.log(1);
53+
console.log(1);
54+
</script>
55+
</body>
56+
</html>
57+
```

‎dist/package/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"name":"console-in-dom","version":"1.0.1","description":"rewite browser's method of console.log, console.log in DOM","home":"https://reysun.github.io/console-in-dom/","repository":{"type":"git","url":"git@github.com:ReySun/console-in-dom.git"},"main":"./console.js","keywords":["console","browser","console-in-dom"],"author":"ReySun <reysun_sky@outlook.com>","license":"MIT","typings":"./typings/console.d.ts"}
1+
{"name":"console-in-dom","version":"1.0.2","description":"rewite browser's method of console.log, console.log in DOM","home":"https://reysun.github.io/console-in-dom/","repository":{"type":"git","url":"git@github.com:ReySun/console-in-dom.git"},"main":"./console.js","keywords":["console","browser","console-in-dom"],"author":"ReySun <reysun_sky@outlook.com>","license":"MIT","typings":"./typings/console.d.ts"}

‎npm-publish.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ var package = Object.assign({}, PKG, {
1010

1111
fs.copySync('./dist/global', './dist/package');
1212
fs.copyFileSync('./dist/demo/console.css', './dist/package/console.css');
13+
fs.copyFileSync('./README.md', './dist/package/README.md');
1314
fs.writeJsonSync('./dist/package/package.json', package);
1415
fs.copySync('./dist/typings', './dist/package/typings');
1516
fs.copySync('./dist/cjs', './dist/package/cjs');

‎package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "console-in-dom",
3-
"version": "1.0.1",
3+
"version": "1.0.2",
44
"description": "rewite browser's method of console.log, console.log in DOM",
55
"home": "https://reysun.github.io/console-in-dom/",
66
"repository": {

0 commit comments

Comments
 (0)