diff --git a/.github/images/screenshot.png b/.github/images/screenshot.png new file mode 100644 index 000000000..13e746c8f Binary files /dev/null and b/.github/images/screenshot.png differ diff --git a/CREDITS.md b/CREDITS.md index c85924d0a..7c315383a 100644 --- a/CREDITS.md +++ b/CREDITS.md @@ -1,3 +1,3 @@ -wallabag is mainly developed by [Nicolas Lœuillet](https://github.com/nicosomb), [@j0k3r](https://github.com/j0k3r) and [@tcitworld](https://github.com/tcitworld) under the MIT License. +wallabag is mainly developed by [Nicolas Lœuillet](https://github.com/nicosomb), [@j0k3r](https://github.com/j0k3r), [@tcitworld](https://github.com/tcitworld) and [@Kdecherf](https://github.com/Kdecherf) under the MIT License. Thank you [to others contributors](https://github.com/wallabag/wallabag/graphs/contributors). diff --git a/README.md b/README.md index 21b7e0109..074205612 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,32 @@ - +# wallabag ![CI](https://github.com/wallabag/wallabag/workflows/CI/badge.svg) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/wallabag/wallabag/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/wallabag/wallabag/?branch=master) [![Gitter](https://badges.gitter.im/gitterHQ/gitter.svg)](https://gitter.im/wallabag/wallabag) [![Donation Status](https://img.shields.io/liberapay/goal/wallabag.svg?logo=liberapay)](https://liberapay.com/wallabag/donate) [![Translation status](https://hosted.weblate.org/widgets/wallabag/-/svg-badge.svg)](https://hosted.weblate.org/engage/wallabag/?utm_source=widget) +![License](https://img.shields.io/github/license/wallabag/wallabag) -# What is wallabag? -wallabag is a self-hostable PHP application allowing you to not miss any content anymore. -Click, save and read it when you can. It extracts content so that you can read it when you have time. +wallabag is a web application allowing you to save web pages for later reading. +Click, save and read it when you want. It extracts content so that you won't be distracted by pop-ups and cie. -More information on our website: [wallabag.org](https://wallabag.org). +You can install it on your own server, or you can create an account on [wallabag.it](https://wallabag.it). -If you do not have your own server, consider [the wallabag.it hosting solution](https://wallabag.it). +![wallabag](./.github/images/screenshot.png) + +* Website: [wallabag.org](https://wallabag.org) +* Android app: [wallabag/android-app](https://github.com/wallabag/android-app) +* iOS app: [wallabag/ios-app](https://github.com/wallabag/ios-app) +* Browser extension: [wallabag/wallabagger](https://github.com/wallabag/wallabagger) + +## Documentation + +The documentation is available at https://doc.wallabag.org. + +You can contribute to it through its dedicated repository, available here: https://github.com/wallabag/doc. + +## Installation -# Install wallabag Please read [the documentation to see the wallabag requirements](https://doc.wallabag.org/en/admin/installation/requirements.html). Then you can install wallabag by executing the following commands: @@ -26,16 +38,24 @@ cd wallabag && make install Now, [configure a virtual host](https://doc.wallabag.org/en/admin/installation/virtualhosts.html) to use your wallabag. -# Run on YunoHost -[![Install Wallabag with YunoHost](https://install-app.yunohost.org/install-with-yunohost.png)](https://install-app.yunohost.org/?app=wallabag2) +### Other methods -Wallabag app for [YunoHost](https://yunohost.org). See [here](https://github.com/YunoHost-Apps/wallabag2_ynh) +Refer to the [installation documentation](https://doc.wallabag.org/en/admin/installation/installation.html) for other installation methods. -# Translate wallabag +## Translation -[wallabag](https://hosted.weblate.org/projects/wallabag/) is being translated using [Weblate](https://weblate.org/), a web tool designed to ease translating for both developers and translators. Feel free to help us [translate wallabag](https://hosted.weblate.org/projects/wallabag/)! +This project uses [Weblate](https://weblate.org/) for translation. -# License +Feel free to help us [translating wallabag](https://hosted.weblate.org/projects/wallabag/). + +## Contributing + +To learn more about developing wallabag, please refer to the [contribution guide](./.github/CONTRIBUTING.md). + +Content extraction relies on [Graby](https://github.com/j0k3r/graby), [php-readability](https://github.com/j0k3r/php-readability) and [ftr-site-config](https://github.com/fivefilters/ftr-site-config). + +## License Copyright © 2013-current Nicolas Lœuillet + This work is free. You can redistribute it and/or modify it under the -terms of the MIT License. See the COPYING file for more details. +terms of the MIT License. See the [COPYING.md](./COPYING.md) file for more details.