From 39614ba6e189c7c9155a337c836dfe065e9d4589 Mon Sep 17 00:00:00 2001 From: Guy Sartorelli Date: Wed, 19 Apr 2023 16:25:38 +1200 Subject: [PATCH] DOC Update README.md for CMS 5 --- README.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 4769327..3cbb5ea 100644 --- a/README.md +++ b/README.md @@ -3,6 +3,12 @@ [![CI](https://github.com/silverstripe/silverstripe-restfulserver/actions/workflows/ci.yml/badge.svg)](https://github.com/silverstripe/silverstripe-restfulserver/actions/workflows/ci.yml) [![Silverstripe supported module](https://img.shields.io/badge/silverstripe-supported-0071C4.svg)](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/) +## Installation + +```sh +composer require silverstripe/restfulserver +``` + ## Overview This class gives your application a RESTful API. All you have to do is set the `api_access` configuration option to `true` @@ -10,12 +16,6 @@ on the appropriate DataObjects. You will need to ensure that all of your data m your model layer (ie, the DataObject classes) and not in your Controllers. This is the recommended design for SilverStripe applications. -## Requirements - -* Silverstripe 4.0 or higher - -For a Silverstripe 3.x compatible version of this module, please see the [1.0 branch, or 1.x release line](https://github.com/silverstripe/silverstripe-restfulserver/tree/1.0#readme). - ## Configuration Example DataObject with simple API access, giving full access to all object properties and relations,