aboutsummaryrefslogtreecommitdiffhomepage
path: root/main/app/sprinkles/extend-user/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'main/app/sprinkles/extend-user/README.md')
-rwxr-xr-xmain/app/sprinkles/extend-user/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/main/app/sprinkles/extend-user/README.md b/main/app/sprinkles/extend-user/README.md
new file mode 100755
index 0000000..60a4bcd
--- /dev/null
+++ b/main/app/sprinkles/extend-user/README.md
@@ -0,0 +1,29 @@
+# User Extension Sprinkle (UserFrosting 4.1)
+
+Example sprinkle for extending the User class to contain additional fields.
+
+# 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:
+
+```
+{
+ "require": {
+ "userfrosting/extend-user": "~4.1.1"
+ },
+ "base": [
+ "core",
+ "account",
+ "admin",
+ "extend-user"
+ ]
+}
+```
+
+### Update Composer
+
+- Run `composer update` from the root project directory.
+
+### Run migration
+
+- Run `php bakery bake` from the root project directory.