Skip to content

Commit c91c144

Browse files
Merge pull request #402 from CameraKit/enhancement/readme
Update README & LICENSE
2 parents 5a254d7 + 031b9cd commit c91c144

File tree

7 files changed

+34
-31
lines changed

7 files changed

+34
-31
lines changed

.repo/gh-readme-app.png

-6.77 KB
Binary file not shown.

.repo/gh-readme-app.svg

Lines changed: 1 addition & 0 deletions
Loading

.repo/gh-readme-header.png

-11.4 KB
Binary file not shown.

.repo/gh-readme-header.svg

Lines changed: 1 addition & 0 deletions
Loading

.repo/gh-readme-wk.png

-14.5 KB
Binary file not shown.

LICENSE

Lines changed: 4 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,7 @@
1-
Copyright (c) 2018 CameraKit (https://camerakit.website) and individual contributors.
1+
Copyright 2018 CameraKit (https://camerakit.website)
22

3-
All rights reserved.
3+
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
44

5-
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
6-
7-
1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
8-
9-
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.
10-
11-
3. Neither the name of the CameraKit nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
12-
13-
4. You have obtained an appropriate additional license from CameraKit if you fall into a ‘premium’ status as defined below.
14-
15-
Premium status is attributed to companies that meet ANY the following criteria.
16-
17-
1. Currently generating revenue as a company with a product or service of which CameraKit is redistributed or used in source and/or binary form within.
18-
19-
2. Have completed a round of financing greater than $100,000 as a company of which CameraKit is redistributed or used in source and/or binary form within.
20-
21-
This additional license can be obtain via CameraKit’s website or by reaching out direct via contact@camerakit.email.
22-
23-
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.
5+
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
246

7+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 28 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,50 @@
11
<p align="center">
22
<a href="https://camerakit.website" target="_blank">
3-
<img alt='CameraKit Header' src='.repo/gh-readme-header.png' />
3+
<img alt='CameraKit Header' src='.repo/gh-readme-header.svg' />
44
</a>
55
</p>
66

77
<p align="center">
8-
<a href="https://www.wonderkiln.com" target="_blank">
9-
<img alt='WonderKiln Promo' src='.repo/gh-readme-wk.png'/>
10-
</a>
118
<a href="https://play.google.com/store/apps/details?id=com.camerakit.demo&hl=en" target="_blank">
12-
<img alt='CameraKit Header' src='.repo/gh-readme-app.png'/>
9+
<img alt='CameraKit Header' height="42px" src='.repo/gh-readme-app.svg'/>
10+
</a>
11+
<a href="https://buddy.works/" target="_blank">
12+
<img alt='Buddy.Works' height="42px" src='https://assets.buddy.works/automated-dark.svg'/>
1313
</a>
1414
</p>
1515

1616
<p align="center">
17-
<a href="https://join-slack.camerakit.website"><img src="https://join-slack.camerakit.website/badge.svg" alt="Build Status"></a>
17+
<a href="https://join-slack.camerakit.website"><img src="https://join-slack.camerakit.website/badge.svg" alt="Join Slack"></a>
1818
<a href="https://codeclimate.com/github/wonderkiln/CameraKit-Android"><img src="https://codeclimate.com/github/wonderkiln/CameraKit-Android/badges/coverage.svg" alt="Code Climate"></a>
1919
<a href="https://codeclimate.com/github/wonderkiln/CameraKit-Android"><img src="https://codeclimate.com/github/wonderkiln/CameraKit-Android/badges/issue_count.svg" alt="Code Climate"></a>
2020
</p>
2121

22+
# What is CameraKit?
23+
2224
CameraKit takes one of the hardest Android APIs and makes it into a high level and easy to use library that solves all of your problems.
2325

24-
## Supported by these Awesome Services
25-
[![Buddy](https://assets.buddy.works/automated-dark.svg)](https://buddy.works/)
26+
With CameraKit you are able to effortlessly do the following...
27+
28+
- Image and video capture seamlessly working with the same preview session.
29+
- Automatic system permission handling.
30+
- Automatic preview scaling.
31+
- Create a CameraView of any size (not just presets!).
32+
- Automatic output cropping to match your CameraView bounds.
33+
- Multiple capture methods.
34+
- METHOD_STANDARD: an image captured normally using the camera APIs.
35+
- METHOD_STILL: a freeze frame of the CameraView preview (similar to SnapChat and Instagram) for devices with slower cameras.
36+
- METHOD_SPEED: automatic capture method determination based on measured speed.
37+
- Built-in continuous focus.
38+
- Built-in tap to focus.
39+
- Built-in pinch to zoom.
40+
41+
## Sponsored By
2642

27-
## Sponsors
2843
<a href="https://www.expensify.com/"><img src=".repo/gh-readme-expensify.png"></a>
2944
<a href="https://www.buddy.works/"><img src=".repo/gh-readme-buddyworks.png"></a>
3045

3146
## Setup
47+
3248
Add __CameraKit__ to the dependencies block in your `app` level `build.gradle`:
3349

3450
```groovy
@@ -64,7 +80,9 @@ protected void onPause() {
6480
```
6581

6682
## Detailed Documentation
67-
To check out detailed docs, visit our [Documentation Website](http://docs.camerakit.website)
83+
84+
To check out detailed docs, visit our [Documentation Website](https://docs.camerakit.website)
6885

6986
## License
87+
7088
CameraKit is [MIT License](https://github.com/CameraKit/CameraKit-Android/blob/master/LICENSE)

0 commit comments

Comments
 (0)