Skip to content

Commit 5635562

Browse files
authored
doc update
1 parent 482a5ac commit 5635562

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

README.md

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# Mimer [![Build Status](https://github.com/data-uri/mimer/actions/workflows/main.yml/badge.svg?branch=main)](https://github.com/data-uri/mimer/actions/workflows/main.yml?query=branch%3Amain)
22

3-
> Another [MIME](http://en.wikipedia.org/wiki/MIME) type module. Exposes an extension Map reference of [mime-db](https://npm.im/mime-db) but with zero dependencies.
3+
An file extension to [MIME](http://en.wikipedia.org/wiki/MIME) type module. Uses [mime-db](https://npm.im/mime-db) data but with zero dependencies.
44

5-
## MODULE
5+
## Getting started
6+
`npm install mimer` or `npx mimer <file>`.
67

7-
### Getting started
8+
### Module
89
```js
910
const mimer = require('mimer');
1011

@@ -46,20 +47,20 @@ or just
4647
npx mimer readme.pdf
4748
```
4849

49-
## DEVELOPING
50+
## Contribute
5051

5152
Just create a new Github Codespace or:
5253

53-
```CLI
54+
```sh
55+
$ git clone https://github.com/data-uri/mimer.git
56+
$ cd mimer
5457
$ npm i
5558
$ npm test
5659
```
5760

58-
## Release notes
59-
60-
See more in [Releases section](https://github.com/data-uri/mimer/releases).
61+
## [Changelog](https://github.com/data-uri/mimer/releases).
6162

6263
## License
6364

6465
MIT License
65-
(c) [Helder Santana](http://heldr.com)
66+
(c) [Helder Santana](http://heldr.com)

0 commit comments

Comments
 (0)