Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
bourvill committed Aug 27, 2017
1 parent b679beb commit 3a45446
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 7 deletions.
50 changes: 43 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,28 @@
[![Build Status](https://travis-ci.org/wallabag/ios-app.svg?branch=master)](https://travis-ci.org/wallabag/ios-app)
# wallabag 2 official iOS [![Build Status](https://travis-ci.org/wallabag/ios-app.svg?branch=master)](https://travis-ci.org/wallabag/ios-app)

# wallabag 2 official iOS
<img src="/readme/wallabag_logo.png" align="left" width="200" hspace="10" vspace="10">

wallabag is a self-hosted read-it-later app.
Unlike other services, wallabag is free and open source.
wallabag 2 official iOS is a companion app for [wallabag](https://www.wallabag.org).

<p align="left">
<a href="https://itunes.apple.com/fr/app/wallabag-2-official/id1170800946?mt=8">
<img src="https://linkmaker.itunes.apple.com/assets/shared/badges/en-gb/appstore-lrg.svg"/>
</a>
</p>

## About wallabag

wallabag has been made for you to comfortably read and archive your articles.
You can download wallabag from wallabag.org and follow the instructions to install it on your own server.
Alternatively, you can directly sign up for [wallabag.it](https://wallabag.it) or [Framabag](https://framabag.org).

This application allows you to put a link in your wallabag instance, letting you read your wallabag links offline.

wallabag is a creation from Nicolas Lœuillet released under the MIT License (Expat License).

## About wallabag 2 official iOS

This is a self-learning project.

Expand All @@ -10,9 +32,23 @@ You will find mistakes, many mistakes, do not blame me, learn me with a PR.

You contribute to an excellent opensource project, and you will make me evolve in the Swift language

## Tools required to contribute
* SwiftLint
* Cocoapods
## Features
- Connect to your self-hosted wallabag instance or connect to your [wallabag.it](https://wallabag.it) or [Framabag](https://framabag.org) account.
- Supports wallabag 2.0 and higher.
- Completely ad-free.
- Switch between numerous themes.


## Screenshots
[<img src="/fastlane/framed/iPhone6Plus-01Home-d41d8cd98f00b204e9800998ecf8427e_framed.png" align="left" width="200" hspace="10" vspace="10">](/fastlane/framed/iPhone6Plus-01Home-d41d8cd98f00b204e9800998ecf8427e_framed.png)
[<img src="/fastlane/framed/iPhone6Plus-02Article-d41d8cd98f00b204e9800998ecf8427e_framed.png" align="center" width="200" hspace="10" vspace="10">](/fastlane/framed/iPhone6Plus-02Article-d41d8cd98f00b204e9800998ecf8427e_framed.png)

## Contributing
wallabag app is a free and open source project developed by volunteers. Any contributions are welcome. Here are a few ways you can help:
* [Report bugs and make suggestions.](https://github.com/wallabag/ios-app/issues)
* Write some code. Please follow the code style used in the project to make a review process faster.

## License

## Project installation
Clone the project and run `pod install`
This application is released under GNU GPLv3 (see [LICENSE](LICENSE)).
Some of the used libraries are released under different licenses.
Binary file added readme/wallabag_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 3a45446

Please sign in to comment.