Skip to content

Commit ee7ff14

Browse files
committed
Detail README.md
1 parent a7b8575 commit ee7ff14

File tree

3 files changed

+34
-1
lines changed

3 files changed

+34
-1
lines changed

README.md

+34-1
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,35 @@
11
# Watermarker
2-
Lightweight PDF & image watermarker for macOS
2+
3+
Lightweight PDF & image watermarker for macOS, built using [SwiftUI](https://developer.apple.com/xcode/swiftui)
4+
5+
## Preview
6+
7+
<table style="border: none">
8+
<tr style="border: none">
9+
<td style="border: none"><img src="img/preview-1.png"></td>
10+
<td style="border: none"><img src="img/preview-2.png"></td>
11+
</tr>
12+
</table>
13+
14+
## Installing
15+
16+
Simply grab the latest version from the [release page](https://github.com/JRomainG/Watermarker/releases) (or click [here](https://github.com/JRomainG/Watermarker/releases/latest/download/Watermarker.app.zip)).
17+
18+
## Development
19+
20+
To install, simply checkout the `dev` branch of this repository:
21+
22+
```bash
23+
git clone https://github.com/JRomainG/Watermarker.git
24+
git checkout dev
25+
```
26+
27+
You will then be able to open the `Watermarker.xcodeproj` project. Swift's package manager should automatically download [swift-collections.git](https://github.com/apple/swift-collections.git). Don't forget to change the team and signing certificate before building.
28+
29+
## Contributing
30+
31+
If you found a bug, or would like to see a new feature added, feel free to open an issue on the Github page. Pull requests are welcome!
32+
33+
## License
34+
35+
The project is available under the [GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html) license.

img/preview-1.png

164 KB
Loading

img/preview-2.png

617 KB
Loading

0 commit comments

Comments
 (0)