Skip to content

Commit a276ea5

Browse files
authored
add missing doc (#37)
* add missing doc * fix package version * 4.0.1
1 parent abb4028 commit a276ea5

5 files changed

Lines changed: 22 additions & 16 deletions

File tree

docs/datauri-cli.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,14 @@
66
77
from: [Wikipedia](http://en.wikipedia.org/wiki/Data_URI_scheme)
88

9-
[![Build Status](https://github.com/data-uri/datauri/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/datauri/actions/workflows/main.yml?query=branch%3Amain)
10-
11-
## CLI
9+
## CLI [![Build Status](https://github.com/data-uri/datauri/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/datauri/actions/workflows/main.yml?query=branch%3Amain)
1210

1311
`npm install -g datauri-cli` (it may require Root privileges)
1412

13+
or
14+
15+
`npx datauri-cli <file_path> <flags>`
16+
1517
### Print
1618

1719
To print a data-uri scheme from a file
@@ -53,7 +55,7 @@ $ datauri brand.png --css --backgroundSize
5355

5456
## Requirements
5557

56-
Node.js 8+
58+
Node.js 10+
5759

5860
## License
5961

docs/datauri.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,11 @@ from: [Wikipedia](http://en.wikipedia.org/wiki/Data_URI_scheme)
1414

1515
## MODULE [![Build Status](https://github.com/data-uri/datauri/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/datauri/actions/workflows/main.yml?query=branch%3Amain)
1616

17-
`npm install -S datauri`
17+
`npm install datauri`
1818

1919
### Getting started
2020

21-
By default, datauri module returns a promise, which is resolved with `data:uri` string or rejected with file read error:
21+
By default, datauri module returns a promise, which is resolved with `data:uri` string or rejected with read file error:
2222

2323
```js
2424
const datauri = require('datauri');
@@ -43,6 +43,7 @@ datauri('test/myfile.png', (err, content, meta) => {
4343

4444
console.log(meta.mimetype); //=> "image/png"
4545
console.log(meta.base64); //=> "iVBORw0KGgoAAAANSUhEUgAA..."
46+
console.log(meta.buffer); //=> file buffer
4647
});
4748
```
4849

@@ -71,8 +72,7 @@ const meta = Datauri('test/myfile.png');
7172
console.log(meta.content); //=> "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAA..."
7273
console.log(meta.mimetype); //=> "image/png"
7374
console.log(meta.base64); //=> "iVBORw0KGgoAAAANSUhEUgAA..."
74-
console.log(meta.getCSS()); //=> "\n.case {\n background-image: url('data:image/png;base64,iVBORw..."
75-
console.log(meta.getCSS('myClass')); //=> "\n.myClass {\n background-image: url('data:image/png;base64,iVBORw..."
75+
console.log(meta.buffer); //=> file buffer
7676
```
7777

7878
### From a Buffer

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "datauri-build",
33
"private": true,
4-
"version": "3.0.0",
4+
"version": "4.0.1",
55
"scripts": {
66
"test": "npm run prettier:check && npm run lint && npm run build && npm run jest",
77
"jest": "jest",
@@ -13,7 +13,7 @@
1313
"pkg-json": "mkdir -p lib/datauri && mkdir -p lib/datauri-cli && node tools/pkg-json.js",
1414
"release": "npm run build && npm publish lib/datauri-cli && npm publish lib/datauri",
1515
"preversion": "npm run test",
16-
"postversion": "git commit --amend -a",
16+
"postversion": "git commit --amend -a && npm run build",
1717
"prettier:check": "prettier --check 'src/**/*.ts'",
1818
"prettier:fix": "prettier --write 'src/**/*.ts'"
1919
},

readme.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,19 +8,23 @@
88

99
[Module](http://npm.im/datauri) and [CLI](http://npm.im/datauri-cli) to generate [Data URI scheme](http://en.wikipedia.org/wiki/Data_URI_scheme).
1010

11-
[![Build Status](https://github.com/data-uri/datauri/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/datauri/actions/workflows/main.yml?query=branch%3Amain) [![Dependency Status](https://www.versioneye.com/user/projects/560b7b3f5a262f001e0007e2/badge.svg?style=flat)](https://www.versioneye.com/user/projects/560b7b3f5a262f001e0007e2) [![NPM version](http://img.shields.io/npm/dm/datauri.svg?style=flat)](https://www.npmjs.org/package/datauri)
11+
[![Build Status](https://github.com/data-uri/datauri/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/datauri/actions/workflows/main.yml?query=branch%3Amain) [![NPM version](http://img.shields.io/npm/dm/datauri.svg?style=flat)](https://www.npmjs.org/package/datauri)
1212

1313
## Module
1414

15-
`npm i --save datauri`
15+
`npm i datauri`
1616

17-
[See more in NPM page](http://npm.im/datauri)
17+
[API Docs](http://npm.im/datauri)
1818

1919
## CLI
2020

2121
`npm i -g datauri-cli`
2222

23-
[See more in NPM page](http://npm.im/datauri-cli)
23+
or
24+
25+
`npx datauri-cli <file_path> <flags>`
26+
27+
[CLI Docs](http://npm.im/datauri-cli)
2428

2529
## [ChangeLog](https://github.com/data-uri/datauri/releases)
2630

0 commit comments

Comments
 (0)