Skip to content
This repository has been archived by the owner on Dec 11, 2022. It is now read-only.

Commit

Permalink
Version bump and new readme.
Browse files Browse the repository at this point in the history
  • Loading branch information
hperrin committed Oct 24, 2017
1 parent 280c08e commit 3a9d5d7
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 5 deletions.
50 changes: 48 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,49 @@
# <img alt="logo" src="https://raw.githubusercontent.com/sciactive/2be-extras/master/logo/product-icon-40-bw.png" align="top" /> 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

<div dir="rtl">Quick Setup with Composer</div>

```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).
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
2 changes: 1 addition & 1 deletion composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion src/Nymph.php
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down

0 comments on commit 3a9d5d7

Please sign in to comment.