Skip to content

README improvements #36

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
davereid wants to merge 2 commits into
base: master
Choose a base branch
from
Open

README improvements #36

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04e8883
Missing import for Context class in README
davereid Oct 2, 2023
c9aae76
Update README.md
davereid Oct 2, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ Schema forms is a project that aims to generate form structures for the differen
Frameworks supported:
- Drupal.

# Installation

Generally this should be already required by the Drupal project that needs to use it.

If you need to require this library independently, you can do so with the following command:

```
composer require e0ipso/schema-forms
```

# Usage
Given the following JSON Schema defining the different properties of a user object.
```json
Expand Down Expand Up @@ -80,6 +90,7 @@ And the following UI JSON Schema refining the form generation process:
Execute this PHP code:
```php
use SchemaForms\Drupal\FormGeneratorDrupal;
use Shaper\Util\Context;
$generator = new FormGeneratorDrupal();
$context = new Context(['ui_hints => $ui_schema_data]);
$actual_form = $generator->transform($schema_data, $context);
Expand Down