Skip to content

Commit 12ba054

Browse files
committed
📖 DOC: Update readme and license
1 parent 3fcf99f commit 12ba054

3 files changed

Lines changed: 50 additions & 15 deletions

File tree

‎LICENSE‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
Copyright 2021 - Michael Born of https://michaelborn.me
2+
3+
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
4+
5+
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
6+
7+
2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
8+
9+
3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
10+
11+
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

‎README.md‎

Lines changed: 30 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,14 @@
1111
![Latest release](https://img.shields.io/github/v/release/michaelborn/UpChunk?style=flat-square)
1212
</center>
1313

14+
## Features
15+
16+
* Chunked uploads
17+
* Non-chunked uploads
18+
* DropZone support
19+
* Uploader.js support
20+
* Easily extendable for other vendors
21+
1422
## Getting Started
1523

1624
1. Install this module into your ColdBox app: `box install UpChunk`
@@ -27,15 +35,7 @@ moduleSettings = {
2735
/**
2836
* Set the final resting place of uploaded files.
2937
*/
30-
uploadDir : "resources/assets/uploads/",
31-
32-
/**
33-
* Wirebox ID that points to the vendor CFC to use for uploads.
34-
*
35-
* You can write and use your own custom upload vendor...
36-
* ...but it must implement UpChunk.models.iChunk and extend UpChunk.models.AbstractUploader.
37-
*/
38-
strategy : "DropZone@UpChunk"
38+
uploadDir : "resources/assets/uploads/"
3939
}
4040
};
4141
```
@@ -112,8 +112,26 @@ component extends="UpChunk.models.AbstractUploader" {
112112
}
113113
```
114114

115-
## Limitations
115+
## TODO
116+
117+
* [Pull original filename from form field parts](https://stackoverflow.com/questions/14143076/storing-file-name-when-uploading-using-coldfusion)
118+
* Add TestBox specs:
119+
* integration test chunked uploads
120+
* integration test non-chunked uploads
121+
* unit test vendor providers
122+
123+
## The Good News
124+
125+
> For all have sinned, and come short of the glory of God ([Romans 3:23](https://www.kingjamesbibleonline.org/Romans-3-23/))
126+
127+
> But God commendeth his love toward us, in that, while we were yet sinners, Christ died for us. ([Romans 5:8](https://www.kingjamesbibleonline.org/Romans-5-8))
128+
129+
> That if thou shalt confess with thy mouth the Lord Jesus, and shalt believe in thine heart that God hath raised him from the dead, thou shalt be saved. ([Romans 10:9](https://www.kingjamesbibleonline.org/Romans-10-9/))
130+
131+
## Repository
116132

117-
Lucee doesn't broadcast the filename very well. :/
133+
Copyright 2021 (and on) - [Michael Born](https://michaelborn.me/)
118134

119-
See [this SO post](coldfusion get body filename), but basically you can avoid this by sending a `filename` parameter in the upload request.
135+
* [Homepage](https://github.com/michaelborn/UpChunk)
136+
* [Issue Tracker](https://github.com/michaelborn/UpChunk/issues)
137+
* [New BSD License](https://github.com/michaelborn/UpChunk/blob/master/LICENSE.txt)

‎box.json‎

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
"type":"modules",
1717
"dependencies":{},
1818
"devDependencies":{
19-
"coldbox":"^5.0.0",
20-
"testbox":"^3.0.0"
19+
"coldbox":"^6.0.0",
20+
"testbox":"^4.0.0"
2121
},
2222
"installPaths":{
2323
"testbox":"testbox/",
@@ -41,5 +41,11 @@
4141
"test",
4242
"tests",
4343
"cookie.png"
44+
],
45+
"license":[
46+
{
47+
"URL":"https://github.com/michaelborn/UpChunk/blob/master/LICENSE",
48+
"type":"BSD"
49+
}
4450
]
45-
}
51+
}

0 commit comments

Comments
 (0)