Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akoidan committed Oct 7, 2020
1 parent 5a8346a commit a608775
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 6 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,3 +103,14 @@ new LoggerFactory(0, {
}
})
```

# 5. Building yourself:
- `yarn install` - installs devDependencies. I use `yarn.lock` but npm work as well.
- `yarn build` - compiles code to `./lib` directory. This build has:
- Type definitions in `index.d.ts`
- Umd version for import via script tag `browser.js`
- CommonJS version for if you use bundler like webpack `index.js`.
- `yarn test` - runs mocha tests from `./test/index.ts.
- `yarn lint:check` - lints the src directory. Ignore the `test` dir.
- `yarn lint:fix` - automatically fixes wrong formatting in `src`.
- `yarn publish` - updates npm version
10 changes: 4 additions & 6 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
{
"name": "lines-logger",
"version": "1.3.0",
"version": "1.3.1",
"main": "lib/index.js",
"description": "A simple browser logger that keeps origin source files location",
"scripts": {
"build": "",
"build": "rm -rf ./lib && tsc -p src/tsconfig.json && rollup -c ./rollup.config.js && uglifyjs lib/index.js -o lib/index.js --compress",
"test": "mocha",
"report": "nyc mocha",
"lcov": "nyc report --reporter=text-lcov > coverage.lcov",
"codecov": "codecov",
"check": "gts check",
"clean": "gts clean",
"compile": "rm ./lib -rf && tsc -p src/tsconfig.json && rollup -c ./rollup.config.js && uglifyjs lib/index.js -o lib/index.js --compress",
"fix": "gts fix",
"lint:check": "gts check",
"lint:fix": "gts fix",
"posttest": "npm run check"
},
"repository": {
Expand Down

0 comments on commit a608775

Please sign in to comment.