Skip to content

Commit e95dee0

Browse files
committed
Add logo and touch-ups to README
Update PR template Update contributing guide
1 parent ed385ee commit e95dee0

File tree

5 files changed

+28
-10
lines changed

5 files changed

+28
-10
lines changed

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,10 @@
33
### Checklist
44
- [ ] I've read the [guide for contributing](https://github.com/lordcodes/imagecram/blob/master/CONTRIBUTING.md).
55
- [ ] I've checked there are no other [open pull requests](https://github.com/lordcodes/imagecram/pulls) for the same change.
6-
- [ ] I've made sure all the tests pass with `swift test`.
76
- [ ] I've formatted all code changes with `swift run task format`.
87
- [ ] I've ran all checks with `swift run task lint`.
98
- [ ] I've updated documentation if needed.
10-
- [ ] I've added or updated tests for changes.
9+
- [ ] I've tested all changes are working as intended.
1110

1211
### Reason for change
1312
<!-- If the pull request fixes an open issue, please include a link to the issue here. -->

Art/logo.png

15.6 KB
Loading

CONTRIBUTING.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ If this is your first time contributing to Imagecram, please have a read through
2121
* Clone the repository.
2222
* To build: `swift build`.
2323
* To test: `swift test`.
24+
* To format code: `swift run task format`.
25+
* To run lint: `swift run task lint`.
2426
* To run locally: `swift run imagecram-cli`
2527

2628
Thanks!

Design/logo.xcf

102 KB
Binary file not shown.

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
1-
# Imagecram 🗜
2-
3-
[![SPM](https://img.shields.io/badge/spm-compatible-brightgreen.svg)](https://swift.org/package-manager)
4-
![Platforms](https://img.shields.io/badge/Platforms-macOS-blue.svg)
5-
[![Git Version](https://img.shields.io/github/release/lordcodes/imagecram.svg)](https://github.com/lordcodes/imagecram/releases)
6-
[![license](https://img.shields.io/github/license/lordcodes/imagecram.svg)](https://github.com/lordcodes/imagecram/blob/master/LICENSE)
7-
8-
A command line tool to compress and optimise images using the [TinyPNG service](https://tinypng.com).
1+
<p align="center">
2+
<img src="Art/logo.png" width="500" max-width="90%" alt="Imagecram" />
3+
</p>
4+
5+
<p align="center">
6+
<img src="https://img.shields.io/badge/Swift-5.1-orange.svg" />
7+
<a href="https://swift.org/package-manager">
8+
<img src="https://img.shields.io/badge/swiftpm-compatible-brightgreen.svg?style=flat" alt="Swift Package Manager" />
9+
</a>
10+
<img src="https://img.shields.io/badge/platforms-mac+linux-brightgreen.svg?style=flat" alt="Mac + Linux" />
11+
<a href="https://github.com/lordcodes/imagecram/releases/latest">
12+
<img src="https://img.shields.io/github/release/lordcodes/imagecram.svg?style=flat" alt="Latest release" />
13+
</a>
14+
<a href="https://twitter.com/lordcodes">
15+
<img src="https://img.shields.io/badge/twitter-@lordcodes-blue.svg?style=flat" alt="Twitter: @lordcodes" />
16+
</a>
17+
</p>
18+
19+
This is **Imagecram** - a tool to quickly and easily compress images straight from your command line.
20+
21+
Compression is currently handled using the really powerful [TinyPNG service](https://tinypng.com).
922

1023
## Features
1124

@@ -102,6 +115,10 @@ imagecram old.png -o new.png
102115
imagecram *.png -o compressed
103116
```
104117

118+
## Future
119+
120+
The plan is to implement image compression within the tool itself to remove the restriction of providing a TinyPNG API key and being limited on how many images they will compress for free each month. There is currently no time-frame on this and it will depend on simplicity and how effectively it compresses the images.
121+
105122
## Contributing or Help
106123

107124
If you notice any bugs or have a new feature to suggest, please check out the [contributing guide](https://github.com/lordcodes/imagecram/blob/master/CONTRIBUTING.md). If you want to make changes, please make sure to discuss anything big before putting in the effort of creating the PR.

0 commit comments

Comments
 (0)