updated README.md

Author: liplum

README.md

@@ -25,13 +25,21 @@ composer update liplum/flarum-sync-profile-core
 
 ## How to Use
 
-For flarum administrators, if you're using an authentication extension that uses this extension, you can use the settings popup on the Flarum Admin extensions page to choose which types of attributes you'd like to sync.
+## For Flarum Admins
 
-Please note that in order to sync Bios and Masquerade Profile Fields, you need to install and enable the [Friends of Flarum User Bios](https://github.com/FriendsOfFlarum/user-bio) and [Friends of Flarum Masquerade](https://github.com/FriendsOfFlarum/masquerade) extensions.
+If you're using an authentication or auth-sync extension based on this extension
+you can choose which types of attributes you'd like to sync on the extension settings page.
 
-To use this extension in another authentication extension:
+Note that in order to sync Bios and Masquerade Profile Fields, you need to install and enable the corresponding extensions:
 
-1. Install the extension as dev dependency: `composer require liplum/sync-profile-core`.3
+- [Friends of Flarum User Bios](https://github.com/FriendsOfFlarum/user-bio)
+- [Friends of Flarum Masquerade](https://github.com/FriendsOfFlarum/masquerade)
+
+## For Extension Developers
+
+To develop an authentication or auth-sync extension based on this extension, you should:
+
+1. Install the extension as dev dependency: `composer require liplum/sync-profile-core`.
 2. Inject `ExtensionManager $extensions` in your constructor.
 3. Import the AuthEventSync model via `use Liplum\SyncProfile\Event\SyncProfileEvent;`
 4. Before logging in/registering the user, create an AuthSyncEvent. Ex:
@@ -58,20 +66,21 @@ if ($this->extensions->isEnabled('liplum-sync-profile-core')) {
 }
 ```
 
-- Of course, replace the generic values above with attributes from your Identity Provider's response.
-- Attributes should be provided in a json-encoded string (see above example). The JSON string should have the following attributes:
-  - `avatarUrl`: A URL pointing to an image for the user's avatar. Make sure that the file type is compatible with Flarum (jpeg or png I believe).
-  - `groups`: A comma-separated list of ids for groups that a user should belong to. Keep in mind that this will both add and remove groups, so make sure that all desired groups are included.
-  - `bio`: A string that will be synced to the user's bio if [Friends of Flarum User Bios](https://github.com/FriendsOfFlarum/user-bio) is enabled
-  - `fof-masquerade`: An associative array for any masquerade keys and attributes you want to sync. Make sure that the key matches the name of the profile field exactly.
+Replace the generic values above with attributes from your Identity Provider's response.
+
+Attributes should be provided in a json-encoded string (see above example). The JSON string should have the following attributes:
+
+- `nickname`: The display name of a user.
+- `avatarUrl`: A URL pointing to an image for the user's avatar. Make sure that the file type is compatible with Flarum (jpeg or png I believe).
+- `groups`: A comma-separated list of ids for groups that a user should belong to. Keep in mind that this will both add and remove groups, so make sure that all desired groups are included.
+- `bio`: A string that will be synced to the user's bio if [Friends of Flarum User Bios](https://github.com/FriendsOfFlarum/user-bio) is enabled
+- `fof-masquerade`: An associative array for any masquerade keys and attributes you want to sync. Make sure that the key matches the name of the profile field exactly.
 
 ### TODO
 
 - Add better validation and error handling.
 - Add a setting to support default groups that all users should be added to, and groups that users should never be synced to.
-- Add an expiry setting for Auth Sync Events.
 - Add support for getting users via LoginProvider providers and identifiers, in addition to email.
-- Due to a bug in flarum core, the `LoggedIn` event isn't dispatched when logging in via an external identity provider. Until this is fixed, the UserUpdatedListener listens to `Serialize` events (except those going to masquerade). This workaround will be promptly removed when the upstream bug is fixed.
 
 ## Acknowledgement
 

resources/locale/en.yml

@@ -7,7 +7,7 @@ liplum-sync-profile-core:
       help: >
         Block users from changing their profile on Flarum.
         Working properly with extensions like "FoF User Bio".
-        Not working with extensions which not respect "editable" attribute on user,
+        Not working with extensions which not respect "editable" attributes on user,
         like "Profile Cover", "User Badges".
     sync-avatar:
       label: Sync Avatar