Conduitry
/
defiler
1
Fork 0
Code Releases Activity

update docs

This commit is contained in:
Conduitry 2018-01-30 06:47:33 -05:00
parent 58b2f170e2
commit bbdec22341
4 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
API.md
View File

@ -125,6 +125,8 @@ Typically, you would not need to call this directly, as it would be automaticall
Manually insert a non-physical `File`, running it through all the transforms.
For convenience, you can also call this with a plain old JavaScript object, and a new `File` instance will be created for you with fields `Object.assign`ed from the object.
Returns a `Promise` to indicate when all processing is complete.
### `close()`

0
USAGE.md → GUIDE.md
View File

2
LICENSE
View File

@ -1,6 +1,6 @@
MIT License
Copyright (c) 2017 Conduitry
Copyright (c) 2017-2018 Conduitry
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

4
README.md
View File

@ -34,13 +34,13 @@ If you need some task management, that's outside the scope of this library. Just
## Documentation
- [usage](USAGE.md#readme)
- [guide](GUIDE.md#readme)
- [api](API.md#readme)
- [changelog](CHANGELOG.md#readme)
- [homepage](https://cndtr.io/defiler/)
## License
Copyright (c) 2017 Conduitry
Copyright (c) 2017-2018 Conduitry
- [MIT](LICENSE)