Skip to content

Commit

Permalink
Updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
lcharette committed Mar 7, 2018
1 parent 993902e commit 4ce3a83
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,12 @@
# Custom User Profile Field Sprinkle for [UserFrosting 4](https://www.userfrosting.com)

This Sprinkle makes it easy to add any custom fields to the user or group model. Simply create a new schema in you own sprinkle and you're done. Your new profile fields will be automcatically integrated in the default UserFrosting interface.
[![UserFrosting Version](https://img.shields.io/badge/UserFrosting->=%204.2-brightgreen.svg)](https://github.com/userfrosting/UserFrosting) [![Donate](https://img.shields.io/badge/Donate-Buy%20Me%20a%20Coffee-brightgreen.svg)](https://ko-fi.com/A7052ICP)

> This version only works with UserFrosting 4.1.x !
This Sprinkle makes it easy to add any custom fields to the user or group model. Simply create a new schema in you own sprinkle and you're done. Your new profile fields will be automatically integrated in the default UserFrosting interface.

# Help and Contributing

If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the [UserFrosting Chat](https://chat.userfrosting.com/) most of the time for direct support.

<a href='https://ko-fi.com/A7052ICP' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://az743702.vo.msecnd.net/cdn/kofi4.png?v=0' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
If you need help using this sprinkle or found any bug, feels free to open an issue or submit a pull request. You can also find me on the [UserFrosting Chat](https://chat.userfrosting.com/) most of the time for direct support.

# Installation

Expand Down Expand Up @@ -84,7 +82,7 @@ For example, you can add the following to a `schema/userProfile/myFields.json` f
}
```

Note that the schema must be saved inside the `schema/userProfile/` directory of your sprinkle to be picked up automatically by the system. You might also want to run `php bakery clear-cache` command from the UserFrosting root since thoses fields are stored in cache for better performances.
Note that the schema must be saved inside the `schema/userProfile/` directory of your sprinkle to be picked up automatically by the system. You might also want to run `php bakery clear-cache` command from the UserFrosting root since those fields are stored in cache for better performances.

You can also specify **groups** custom fields by saving any schema in the the `schema/groupProfile/` directory of your sprinkle.

Expand All @@ -93,5 +91,5 @@ You can also specify **groups** custom fields by saving any schema in the the `s
![Screenshot 1](/screenshots/UF_UserProfile1.png?raw=true)
![Screenshot 1](/screenshots/UF_UserProfile2.png?raw=true)

# Licence
# License
By [Louis Charette](https://github.com/lcharette). Copyright (c) 2017, free to use in personal and commercial software as per the MIT license.
2 changes: 2 additions & 0 deletions src/Util/UserProfileHelper.php
Original file line number Diff line number Diff line change
Expand Up @@ -147,6 +147,8 @@ public function getFieldsSchema()
protected function getSchemaContent($schemaLocation)
{
$schemas = array();

/** @var \RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator $locator */
$locator = $this->ci->locator;

// Define the YAML loader
Expand Down

0 comments on commit 4ce3a83

Please sign in to comment.