diff --git a/README.md b/README.md index a950f13..60a4bcd 100644 --- a/README.md +++ b/README.md @@ -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. \ No newline at end of file +- Run `php bakery bake` from the root project directory. diff --git a/composer.json b/composer.json index 26163a0..4c8a0fa 100644 --- a/composer.json +++ b/composer.json @@ -1,6 +1,8 @@ { "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" : [ { @@ -8,10 +10,13 @@ "homepage": "https://alexanderweissman.com" } ], - "version": "1.1.0", "autoload": { "psr-4": { "UserFrosting\\Sprinkle\\ExtendUser\\": "src/" } + }, + "extra": { + "installer-name": "extend-user" } } +