README.md

   1 # Dabr
   2
   3 ------
   4 ***Announcement:** I (@rahuldottech) am now the official dev of Dabr! I'm working on getting it set up on my own server, and will start working through and fixing the issues soon! If you have any questions, please don't hesitate to contact me (`r@hul.space`).*
   5
   6 ------
   7
   8 Dabr is designed to be a **fast** and **free** way to access Twitter via *any* mobile phone.
   9
  10 It is specifically targeted at users with limited bandwidth, slow computers / phones, or those who just prefer a **simple** website.
  11
  12 To play with the latest version of Dabr, visit https://dabr.eu/
  13
  14 This is a fork of the [original Dabr code](https://code.google.com/p/dabr/) by one of its main contributors.
  15
  16 [![Buy me a coffee](https://www.ko-fi.com/img/donate_sm.png)](https://ko-fi.com/edent)
  17
  18
  19 ## How to install
  20
  21 Dabr is designed to be *as simple as possible* to install on your webserver.  If you can run PHP v5.5.0 on your server, you can run Dabr.
  22
  23 1. [Download the code](https://github.com/edent/Dabr/archive/master.zip) from GitHub.
  24 2. Edit the file `config.sample.php` and rename it to `config.php`.
  25     - You'll need to [register for a Twitter API key](https://apps.twitter.com/) for your app.
  26 3. Upload everything onto your server - you should be good to go!
  27
  28 ## Feedback
  29
  30 Found a bug? Got a suggestion?  Please create an issue on GitHub - or contact me on Twitter [@edent](https://twitter.com/edent).
  31
  32 ## Licenses
  33
  34 - The Dabr code is [MIT License](http://opensource.org/licenses/mit-license.php)
  35 - The [CodeBird Twitter Library](https://github.com/jublonet/codebird-php/) is GPLv3.
  36 - The fonts were generated at [Fontello.com](http://fontello.com) and have various free licenses which can be found in `i/fonts/LICENSE.txt`
  37 - Dabr icon is from [Iconfinder](https://www.iconfinder.com/iconsets/toys)
  38 - [twitter-text.js is Copyright 2011 Twitter, Inc. and Licensed under the Apache License, Version 2.0](https://github.com/twitter/twitter-text/blob/master/js/LICENSE)