From 1d20fdeafa24dd92ce3dfafdec71427ed9c8947d Mon Sep 17 00:00:00 2001 From: Sergey Chernyshev Date: Thu, 19 Jul 2012 00:48:34 -0400 Subject: [PATCH] Replaced installation documentation in README with a link to documentation wiki. --- README.md | 90 +------------------------------------------------------ 1 file changed, 1 insertion(+), 89 deletions(-) diff --git a/README.md b/README.md index f4b6c57..3a9f4fc 100644 --- a/README.md +++ b/README.md @@ -9,95 +9,7 @@ One of main goals for the project is to allow fast idea-to-product cycle so we a It is distributed under [MIT license](http://opensource.org/licenses/MIT) distributed with the code in [LICENSE](https://github.com/StartupAPI/users/blob/master/LICENSE) file. ## Installation - -Another important goal for the project are simple installation and upgrades. Let us know where you experience problems and we'll try to reduce the friction. - -Follow these steps: - -1. Get the code from GitHub into the root of your site under users folder: -``` - git clone git://github.com/StartupAPI/users.git users -``` - or you can just download [latest package](https://github.com/StartupAPI/users/downloads) from downloads section - -2. If you don't have it yet, create MySQL database and get user credentials for it - -3. Copy sample configuration file to the same folder where you created users folder in step 1: -``` - cp users/users_config.sample.php users_config.php -``` -4. Fill out `users_config.php` - as minimum, seed the secret for cookie encryption and set DB credentials -```php - getID(); -``` - You will most likely want to show a login menu in the top-right corner of your page. You can do it by simply including navbox.php file like so: -```php -
-``` - -8. Sit back and relax Go implement your business logic now. You can call `getID()`, `getName()` and other methods on the user object to utilize it in your code. - -## Upgrading - -As usual, make a backup of the database to avoid loosing data in case of disasters. - -Then just run make - it should grab the latest code and run database update scripts to bring schema up to date with the code. -``` -make -``` -## Additional features - -When you're comfortable with basic features and want to explore more, go check the documentation (TODO [write the documentation](https://github.com/StartupAPI/users/issues/46)) for more advanced features like embedding registration / login forms on your pages, activity tracking, feature management and so on. +[Installation](http://startupapi.org/Startup_API/Installation) instructions and the rest of the documentation are available on project wiki at [StartupAPI.org](http://startupapi.org/) ## Problems and Questions