Skip to content

introduce main ideas in opening of doco #583

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

Merged
merged 1 commit into from
Mar 3, 2016
Merged

introduce main ideas in opening of doco #583

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
12 changes: 9 additions & 3 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,13 @@ Documentation
Basic Usage
-----------

First, expose your schema, form, and model to the $scope.
Don't forget to load the `schemaForm` module.
After installing, load the `schemaForm` module in your module definition.

Then, in your controller, expose your [schema](http://json-schema.org/),
form, and [model](https://docs.angularjs.org/guide/databinding) to the $scope.
Your schema defines your data structure, the form definition
draws on this definition to define the user interface, and the
model binds the user input to the controller.

```javascript
angular.module('myModule', ['schemaForm'])
Expand Down Expand Up @@ -83,7 +88,8 @@ angular.module('myModule', ['schemaForm'])
}
```

Then load them into Schema Form using the `sfSchema`, `sfForm`, and `sfModel` directives.
Then, in your template, load them into Schema Form using the
`sfSchema`, `sfForm`, and `sfModel` directives.

```html
<div ng-controller="FormController">
Expand Down