Skip to content

Commit

Permalink
update README to make it better
Browse files Browse the repository at this point in the history
  • Loading branch information
zbryikt committed Nov 9, 2020
1 parent 9e08102 commit 8135d0f
Showing 1 changed file with 22 additions and 17 deletions.
39 changes: 22 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,6 @@
# fedep

see also:
- frontend-dependencies - https://github.com/msurdi/frontend-dependencies
- pancake - https://github.com/govau/pancake

frontend dependency installer. copy frontend modules to desired directory, with additional configurations in package.json:

Frontend dependency installer. copy frontend modules to desired directory, with additional configurations in package.json:

"scripts": {
...
Expand All @@ -16,24 +11,34 @@ frontend dependency installer. copy frontend modules to desired directory, with
"modules": [ "ldLazy" ]
}

1. install via npm
2. auto copy to static/assets/lib/<name>/<version>/ after install
2. synlink <version> to /main/
3. can manually trigger copy action
4. work with bundler?

script({name, version, "dist/..."})
by executing `npx fedep` or invoking via postinstall when `npm i`, `fedep` will do:

- copy content of `dist` directory (configurable as `dir` option, see below) in specified packages to static/assets/lib/<name>/<version>/ after install
- build a symbolic link from <version> to /main/

## modules format

## Modules Format

you can use either string or object to list modules to be used. e.g.,

["ldLazy", {name: "ldview"}]
["ldLazy", ..., {name: "ldview"}, ...]


If object is used, it contains following fields:

- name - module name
- browserify - true if browserify this module
- dir - subdir to copy in this module
- `name` - module name
- `browserify` - true if browserify this module
- `dir` - subdir to copy in this module. default `dist` if not specified


## Alternatives

see also:
- frontend-dependencies - https://github.com/msurdi/frontend-dependencies
- pancake - https://github.com/govau/pancake


## License

MIT

0 comments on commit 8135d0f

Please sign in to comment.