Skip to content

Commit

Permalink
update composer and installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
alexweissman committed Oct 12, 2017
1 parent 64d20a8 commit 810d7e4
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 10 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,28 @@

Example sprinkle for extending the User class to contain additional fields.

## Install
`cd` into the sprinkle directory of UserFrosting and clone as submodule:
# Installation

Edit UserFrosting `app/sprinkles.json` and add the following to the `require` list : `"userfrosting/extend-user": "~4.1.1"`. Also add `extend-user` to the `base` list. For example:

```
git submodule add git@github.com:userfrosting/extend-user.git extend-user
{
"require": {
"userfrosting/extend-user": "~4.1.1"
},
"base": [
"core",
"account",
"admin",
"extend-user"
]
}
```

### Add to the sprinkle list
Edit UserFrosting `app/sprinkles.json` file and add `extend-user` to the sprinkle list to enable it.

### Update the assets build & composer
### Update Composer

- Run `composer update` from the root project directory.

### Run migration

- Run `php bakery bake` from the root project directory.
- Run `php bakery bake` from the root project directory.
9 changes: 7 additions & 2 deletions composer.json
Original file line number Diff line number Diff line change
@@ -1,17 +1,22 @@
{
"name": "userfrosting/extend-user",
"type": "sprinkle",
"type": "userfrosting-sprinkle",
"description": "An example Sprinkle for extending the User model and table with additional fields or relationships.",
"homepage": "https://github.com/userfrosting/extend-user",
"license" : "MIT",
"authors" : [
{
"name": "Alexander Weissman",
"homepage": "https://alexanderweissman.com"
}
],
"version": "1.1.0",
"autoload": {
"psr-4": {
"UserFrosting\\Sprinkle\\ExtendUser\\": "src/"
}
},
"extra": {
"installer-name": "extend-user"
}
}

0 comments on commit 810d7e4

Please sign in to comment.