diff --git a/README.md b/README.md index f62b2f7..abc0b30 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,49 @@ -# logo Nymph - Server Files +# Nymph Server - collaborative app data -This repository contains the server side files required by Nymph. Please direct all bug reports, feature requests, and questions to the [main Nymph repository](https://github.com/sciactive/nymph). +[![Build Status](https://img.shields.io/travis/sciactive/nymph-server/master.svg?style=flat)](http://travis-ci.org/sciactive/nymph-server) [![Latest Stable Version](https://img.shields.io/packagist/v/sciactive/nymph-server.svg?style=flat)](https://packagist.org/packages/sciactive/nymph-server) [![License](https://img.shields.io/packagist/l/sciactive/nymph-server.svg?style=flat)](https://packagist.org/packages/sciactive/nymph-server) [![Open Issues](https://img.shields.io/github/issues/sciactive/nymph-server.svg?style=flat)](https://github.com/sciactive/nymph-server/issues) + +Nymph is an object data store that is easy to use in JavaScript and PHP. + +## Installation + +You can install Nymph Server with Composer. + +```sh +composer require sciactive/nymph-server +``` + +This repository is the PHP ORM and REST server. For more information, you can see the [main Nymph repository](https://github.com/sciactive/nymph). + +## Setting up a Nymph Application + +
Quick Setup with Composer
+ +```sh +composer require sciactive/nymph +``` +```php +require 'vendor/autoload.php'; +use Nymph\Nymph; +Nymph::configure([ + 'MySQL' => [ + 'host' => 'your_db_host', + 'database' => 'your_database', + 'user' => 'your_user', + 'password' => 'your_password' + ] +]); + +// You are set up. Now make a class like `MyEntity` and use it. + +$myEntity = new MyEntity(); +$myEntity->myVar = "myValue"; +$myEntity->save(); + +$allMyEntities = Nymph::getEntities(['class' => 'MyEntity']); +``` + +For a thorough step by step guide to setting up Nymph on your own server, visit the [Setup Guide](https://github.com/sciactive/nymph/wiki/Setup-Guide). + +## Documentation + +Check out the documentation in the wiki, [Technical Documentation Index](https://github.com/sciactive/nymph/wiki/Technical-Documentation). diff --git a/composer.json b/composer.json index 75ed9e7..3bc2388 100644 --- a/composer.json +++ b/composer.json @@ -1,7 +1,7 @@ { "name": "sciactive/nymph-server", "description": "Powerful object data storage and querying for collaborative web apps.", - "version": "2.0.0", + "version": "2.1.0", "time": "2017-10-22", "homepage": "http://nymph.io/", "type": "library", diff --git a/composer.lock b/composer.lock index d22bdb2..2a620a8 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "content-hash": "7767901c118f60913dfe3a2005d9eef9", + "content-hash": "c5175898cc2f7112f12650db60923838", "packages": [ { "name": "sciactive/requirephp", diff --git a/src/Nymph.php b/src/Nymph.php index 7700fea..7faeafb 100644 --- a/src/Nymph.php +++ b/src/Nymph.php @@ -26,7 +26,7 @@ * @link http://nymph.io/ */ class Nymph { - const VERSION = '2.0.0'; + const VERSION = '2.1.0'; public static function __callStatic($name, $args) { return call_user_func_array(array(RequirePHP::_('Nymph'), $name), $args);