version bump
[ShaarliOS.git] / README.md
blob5d0b39f891484fa0a6351434aba6b4e537710cd3
2 # 💫 The iOS 9+ share extension for [Shaarli](https://github.com/shaarli/Shaarli#readme). Once ShaarliOS, now #Shaarli💫
4 Share links with ease from every iOS app.
6 ![Icon](shaarli-petal.svg)
7 [![App Store Badge](appstore/Download_on_the_App_Store_Badge_US-UK_135x40.svg)](https://itunes.apple.com/us/app/ShaarliOS/id1027441388?mt=8)
9 Please [rate the App ⭐️](https://apps.apple.com/us/app/shaarlios/id1027441388?mt=8&action=write-review) – whether you like it or not. Each rating is valuable.
11 ## Support
13 If you encounter a bug, please
14 [file an issue 🐞](https://github.com/mro/ShaarliOS/issues/new?&body=Thank%20you%20for%20the%20report,%20please%20add%0a%0a-%20screenshot%20showing%20the%20bug,%0a-%20App%20version,%0a-%20Shaarli%20server%20version.)
16 [send me an email 📧](mailto:shaarlios-bug@mro.name?subject=[ShaarliOS]%20Bugreport&body=Thank%20you%20for%20the%20report,%20please%20add%0a%0a-%20screenshot%20showing%20the%20bug,%0a-%20App%20version,%0a-%20Shaarli%20server%20version.).
18 ## Screenshots
20 <img title="iPhone 4: Note" src="appstore/screenshots/en-US/1_iphone35_note.png" width="200px"/> <img title="iPhone 4: Share Settings" src="appstore/screenshots/en-US/2_iphone35_share_sheet.png" width="200px"/> <img title="iPhone 4: Share" src="appstore/screenshots/en-US/3_iphone35_share.png" width="200px"/> <img title="iPad 2: Note" src="appstore/screenshots/en-US/1_ipad_note.png" width="400px"/>
22 ## Compatibility
24 > !! future verions (1.5+) shall use an API, see https://mro.name/ShaarliO/api
26 All Shaarli versions from current
27 [community fork](https://github.com/shaarli/Shaarli/releases) back to
28 [vanilla](https://github.com/sebsauvage/Shaarli/releases), on all old and
29 [current PHP versions](http://php.net/supported-versions.php), all
30 [themes and templates](https://github.com/shaarli/shaarli-themes).
32 If your version is missing or you found a Shaarli that doesn't work, please file an
33 [issue](https://mro.name/ShaarliOS/issues).
35 ## License
37 - `shaarli-*.svg` by [idleman](http://blog.idleman.fr/), [zlib/libpng OSI licence](http://www.opensource.org/licenses/zlib-license.php),
38 - `*/*.svg */*.png` by [idleman](http://blog.idleman.fr/) and [mro](http://mro.name/~me), [zlib/libpng OSI licence](http://www.opensource.org/licenses/zlib-license.php),
39 - `*/ShaarliOS/3rd/KeychainPasswordItem.swift` by [Apple Inc.](https://apple.com), all rights reserved,
40 - `appstore/Download_on_the_App_Store_Badge_US-UK_135x40.svg` by [Apple Inc.](http://apple.com), all rights reserved,
41 - *all others* by [mro](http://mro.name/~me), [GPL v3](http://www.gnu.org/licenses/gpl-3.0.html)
43 ## Credits
45 except the material used and listed above, I'm happy to thank
47 - [community Shaarli](https://github.com/shaarli/Shaarli) by [the github shaarli contributors](https://github.com/shaarli/Shaarli/graphs/contributors),
48 - [vanilla Shaarli](http://sebsauvage.net/wiki/doku.php?id=php:shaarli) by [sebsauvage](http://sebsauvage.net/),
49 - [Dimitri van Heesch's doxygen](http://www.stack.nl/~dimitri/doxygen/),
50 - [Ben Gardner's uncrustify](http://uncrustify.sourceforge.net/),
51 - all the [contributors to git](https://github.com/git/git/graphs/contributors),
52 - [Rowan James' GitX fork](http://rowanj.github.io/gitx/),
53 - [Inkscape communiy](https://inkscape.org/en/community/),
54 - [stackoverflow](http://stackoverflow.com/),
55 - [Apple Inc.](http://apple.com/).
57 ## Privacy
59 When getting the App from the App Store, the terms and conditions of Apple apply https://www.apple.com/de/legal/privacy/
61 When posting, the terms of your own server (the one you post to) also apply.
63 The App itself collects no data.
65 ## Design Goals
67 | Quality         | very good | good | normal | irrelevant |
68 |-----------------|:---------:|:----:|:------:|:----------:|
69 | Functionality   |           |      |    ×   |            |
70 | Reliability     |           |  ×   |        |            |
71 | Usability       |     ×     |      |        |            |
72 | Efficiency      |           |      |    ×   |            |
73 | Changeability   |           |  ×   |        |            |
74 | Portability     |           |      |        |      ×     |