update readme
authorRich Lott / Artful Robot <code.commits@artfulrobot.uk>
Fri, 23 Jun 2023 11:53:18 +0000 (12:53 +0100)
committerTim Otten <totten@civicrm.org>
Fri, 23 Jun 2023 20:27:44 +0000 (13:27 -0700)
ext/standaloneusers/README.md

index c66b127d20c5b0412032aa9138875befb67f6345..36d1a9bd17c3cdc0abef8e94ae65518cf9424cbc 100644 (file)
@@ -1,4 +1,4 @@
-# Users, Roles, Permissions for Standalone CiviCRM 
+# Users, Roles, Permissions for Standalone CiviCRM
 
 **⚠️ Do not use this extension if you have CiviCRM installed the normal way (e.g. on Drupal, WordPress, Joomla, Backdrop...)!**
 
@@ -13,7 +13,6 @@ The extension is licensed under [AGPL-3.0](LICENSE.txt).
 * PHP v7.4+
 * CiviCRM (standalone)
 
-
 ## Getting started
 
 First, get standalone set up - e.g. you can see the admin interface up and running.
@@ -22,7 +21,13 @@ Next configure AuthX from **Administer » System Settings » Authentication**. Y
 
 Now you can install this extension from the command line. (Clone this repo into web/upload/ext/ then enable it with `cv en standaloneusers`).
 
-On install, an account is created, user `admin`, and the password is printed on the console. The admin user is granted all permissions.
+On install, an account is created, user `admin`, and the password is printed on the console. The admin user is granted all permissions. Example:
+
+```
+% cv en standaloneusers
+Enabling extension "standaloneusers"
+Created New admin User 1 and contact 203 with password iLkPsffZYYA= and ALL permissions.
+```
 
 Now if you try to load your site it should fail: you've got no access rights.
 
@@ -31,7 +36,6 @@ At this stage, because you're moving from a system that had no concept of users
 Done that? Then head to `/civicrm/login`, enter your credentials and hopefully you're now back in the admin interface!
 
 
-
 ## Conventions
 
 From the `Civi\Auth\Standalone` class, the User.id is stored in the global `$loggedInUserId` and when there's a session, under the key `ufId`.