aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2015-02-14 13:49:36 +0100
committernodiscc <nodiscc@gmail.com>2015-02-14 13:49:36 +0100
commit97f7ac4dd496a932ace59b6e316a1089aaf0a267 (patch)
tree541e775e9d4d13903bbbe585f7733490bae09939 /README.md
parentaa69403cfff6734243f74a14251afd775bacc11a (diff)
parenta6e0134d07f7a77f1da97d9d563e339057ff8d54 (diff)
downloadShaarli-97f7ac4dd496a932ace59b6e316a1089aaf0a267.tar.gz
Shaarli-97f7ac4dd496a932ace59b6e316a1089aaf0a267.tar.zst
Shaarli-97f7ac4dd496a932ace59b6e316a1089aaf0a267.zip
Merge pull request #109 from nodiscc/version-check
Update README and Shaarli's footer
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 11 insertions, 7 deletions
diff --git a/README.md b/README.md
index d0743783..6b5086f3 100644
--- a/README.md
+++ b/README.md
@@ -41,12 +41,15 @@ It is designed to be personal (single-user), fast and handy.
41 * You will be automatically notified by a discreet popup if a new version is available 41 * You will be automatically notified by a discreet popup if a new version is available
42 * **Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. See [Usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)** 42 * **Shaarli is a bookmarking application, but you can use it for micro-blogging (like Twitter), a pastebin, an online notepad, a snippet repository, etc. See [Usage examples](https://github.com/shaarli/Shaarli/wiki#usage-examples)**
43 43
44
44## Links 45## Links
46
45 * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)** 47 * **[Wiki/documentation](https://github.com/shaarli/Shaarli/wiki)**
46 * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/) 48 * [Bugs/Feature requests/Discussion](https://github.com/shaarli/Shaarli/issues/)
47 49
48 50
49## Installing 51## Installing
52
50Shaarli requires php 5.1 53Shaarli requires php 5.1
51 54
52 * Download the latest stable release from https://github.com/shaarli/Shaarli/releases 55 * Download the latest stable release from https://github.com/shaarli/Shaarli/releases
@@ -56,21 +59,22 @@ Shaarli requires php 5.1
56 59
57_To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_ 60_To get the development version, download https://github.com/shaarli/Shaarli/archive/master.zip or `git clone https://github.com/shaarli/Shaarli`_
58 61
62
59## Upgrading 63## Upgrading
64
60Delete all files and directories except the `data` directory, then unzip the new version of Shaarli. 65Delete all files and directories except the `data` directory, then unzip the new version of Shaarli.
61You will not lose your links and you will not have to reconfigure it. 66You will not lose your links and you will not have to reconfigure it.
62 67
63 68
64## Screenshots
65
66[![](https://cdn.mediacru.sh/AjZc6-emICeO.png)](https://cdn.mediacru.sh/kE8SyD-PvGuC.png) [![](https://cdn.mediacru.sh/MfC-DzklMYs2.png)](https://cdn.mediacru.sh/iqTvO1-yP9pU.png) [![](https://cdn.mediacru.sh/dxmXskaubYcg.png)](https://cdn.mediacru.sh/mMoi31f94wdL.png) [![](https://cdn.mediacru.sh/-ptB2veFivBp.png)](https://cdn.mediacru.sh/GcoZPZmCZ-DR.png) [![](https://cdn.mediacru.sh/QmRdTAr8x427.png)](https://cdn.mediacru.sh/TDDujpMWT31q.png)
67 69
68## About 70## About
69 71
70Original Project page: http://sebsauvage.net/wiki/doku.php?id=php:shaarli 72This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli
71Shaarli is developed by [Sébastien SAUVAGE](http://sebsauvage.net) and [contributors](COPYING).
72 73
73Shaarli is [Free Software](https://en.wikipedia.org/wiki/Free_software) distributed under the [zlib/libpng License](http://www.gzip.org/zlib/zlib_license.html) 74This is a community fork of the original [Shaarli](https://github.com/sebsauvage/Shaarli/) project by [sebsauvage](http://sebsauvage.net/). The original project is currently unmaintained, and the developer [has informed us](https://github.com/sebsauvage/Shaarli/issues/191) that he would have no time to work on Shaarli in the near future. The Shaarli community has carried on the work to provide [many patches](https://github.com/shaarli/Shaarli/compare/sebsauvage:master...master) for [bug fixes and enhancements](https://github.com/shaarli/Shaarli/issues?q=is%3Aclosed+) in this repository, and will keep maintaining the project for the foreseeable future, while keeping Shaarli simple and efficient. If you'd like to help, have a look at the current [issues](https://github.com/shaarli/Shaarli/issues) and [pull requests](https://github.com/shaarli/Shaarli/pulls) and feel free to report bugs and feature requests, propose solutions to existing problems and send us pull requests.
74 75
75This friendly fork is maintained by the community at https://github.com/shaarli/Shaarli 76
77## License
78
79Shaarli is [Free Software](http://en.wikipedia.org/wiki/Free_software). See [COPYING](COPYING) for a detail of the contributors and licenses for each individual component.
76 80