Skip to content

Commit

Permalink
MINOR: More docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
phptek committed Jun 24, 2016
1 parent a803ba0 commit a18c8d4
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 5 deletions.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,14 +4,21 @@
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/phptek/silverstripe-jsontext/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/phptek/silverstripe-jsontext/?branch=master)
[![License](https://poser.pugx.org/phptek/jsontext/license.svg)](https://github.com/phptek/silverstripe-jsontext/blob/master/LICENSE.md)

JSON storage and querying.
JSON storage, querying and modification.

## Requirements

* PHP 5.4+
* SilverStripe Framework 3.1+
* SilverStripe CMS 3.1+

## Features

* Write JSON to a standard `DBField` subclass.
* Query JSON via simple accessors, Postgres-like operators or JSONPath expressions.
* Selectively return data as JSON, Arrays or cast to SilverStripe `Varchar`, `Int`, `Float` or `Boolean` objects.
* Selectively update specific portions of your source JSON, using JSPNPath expressions.

## Introduction

The module exposes a fully featured JSON query and update API allowing developers to use either XPath-like queries using [JSONPath](http://goessner.net/articles/JsonPath/)
Expand Down
8 changes: 4 additions & 4 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
{
"name": "phptek/jsontext",
"description": "JSON storage and querying",
"description": "JSON storage, querying and modification.",
"type": "silverstripe-module",
"keywords": ["silverstripe", "JSON", "json", "Field", "Query"],
"keywords": ["silverstripe", "JSON", "JSON Field", "json", "Field", "Query", "Text", "JSONPath", "Postgres"],
"license": "BSD",
"authors": [
{
"name": "Russell Michell",
"homepage": "http://theruss.com",
"homepage": "http://theruss.com/",
"email": "[email protected]"
}
],
"require": {
"php": ">=5.4,<7",
"silverstripe/framework": "~3.1",
"silverstripe/cms": "~3.1",
"peekmo/jsonpath": "dev-master"
"peekmo/jsonpath": "dev-master"
},
"support": {
"issues": "https://github.com/phptek/silverstripe-jsontext/issues"
Expand Down

0 comments on commit a18c8d4

Please sign in to comment.