OSDN Git Service

xctcc/embrr
[embrj/master.git] / README.md
index b30d783..71a8233 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,38 +1,38 @@
-# Dabr
+embrr, a fork from embr
+========
+This is a twitter web client fork from [embr](https://code.google.com/p/embr/), mainly based on `r91` and merged necessary changes until the latest revisions, updated to Twitter REST API `v1.1` and have some improved features.
 
-------
-***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`).*
+You can download the zip archive of current version [here](https://github.com/AstroProfundis/embrr/zipball/master) if you don't want to use `git-clone`.
 
-------
+How to Install
+--------
+The installation of embrr is pretty much the same with embr's, you just need to get the source, rename `config.sample.php` in `/lib` to `config.php`, edit it with your own app information and upload it to your hosting directory.
 
-Dabr is designed to be a **fast** and **free** way to access Twitter via *any* mobile phone.
+And here are some tips you may want to know:
 
-It is specifically targeted at users with limited bandwidth, slow computers / phones, or those who just prefer a **simple** website.
+ * embrr requires `php-curl` and `php-bcmath`
+ * while not necessarily required, `php-mcrypt` is recommended
+ * embrr is compatible with PHP from version 5.2 to 5.5, we didn't test it on 5.1 or older versions
 
-To play with the latest version of Dabr, visit https://dabr.eu/
+Installing in sub-directory
+--------
+If you need to install embrr in a sub-directory of your website, say, in `/embrr`, you'll need to adjust the `.htaccess` file with `/embrr/user.php` and `/embrr/status.php` instead of `/user.php` and `/status.php`.
 
-This is a fork of the [original Dabr code](https://code.google.com/p/dabr/) by one of its main contributors.
+nginx
+--------
+For nginx users, you'll need to add these lines to your nginx config file:
 
-[![Buy me a coffee](https://www.ko-fi.com/img/donate_sm.png)](https://ko-fi.com/edent)
+    location / {
+        if (!-f $request_filename) {
+            rewrite ^/(\d+)$ /status.php?id=$1 last;
+            rewrite ^/(\w+)$ /user.php?id=$1 last;
+            break;
+        }
+    }
+And of course, adjust it if you are in a sub-directory.
 
+Notes
+--------
+If you're having issues changing pages or sending DMs, try modify your `php.ini` as follows:
 
-## How to install
-
-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.
-
-1. [Download the code](https://github.com/edent/Dabr/archive/master.zip) from GitHub.
-2. Edit the file `config.sample.php` and rename it to `config.php`.
-    - You'll need to [register for a Twitter API key](https://apps.twitter.com/) for your app. 
-3. Upload everything onto your server - you should be good to go!
-
-## Feedback
-
-Found a bug? Got a suggestion?  Please create an issue on GitHub - or contact me on Twitter [@edent](https://twitter.com/edent).
-
-## Licenses 
-
-- The Dabr code is [MIT License](http://opensource.org/licenses/mit-license.php)
-- The [CodeBird Twitter Library](https://github.com/jublonet/codebird-php/) is GPLv3.
-- The fonts were generated at [Fontello.com](http://fontello.com) and have various free licenses which can be found in `i/fonts/LICENSE.txt`
-- Dabr icon is from [Iconfinder](https://www.iconfinder.com/iconsets/toys)
-- [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)
+    precision = 24 ;Use a value lager than 19 to replace the default 14