Skip to content

Commit 4134371

Browse files
authored
Update README.md
1 parent 32bd1f3 commit 4134371

File tree

1 file changed

+23
-2
lines changed

1 file changed

+23
-2
lines changed

README.md

+23-2
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,35 @@
1-
# Front-end user plugin
1+
# Frontend User plugin
22

33
[![Build Status](https://img.shields.io/github/actions/workflow/status/wintercms/wn-user-plugin/tests.yml?branch=main)](https://github.com/wintercms/wn-user-plugin/actions)
44
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/wintercms/wn-user-plugin/blob/master/LICENCE.md)
55

6-
Front-end user management for Winter CMS.
6+
Provides frontend user management for Winter CMS. This allows you to separate out the users on the frontend of your Winter CMS website / application from the more privileged backend users that come default in Winter CMS.
7+
8+
Supports:
9+
- Users
10+
- Groups
11+
- Registration / Activation / Login / Logout / Password Reset
12+
- Authentication / Authorization
13+
- Extensible by external plugins
714

815
## Requirements
916

1017
This plugin requires either [Snowboard framework](https://wintercms.com/docs/v1.2/docs/snowboard/introduction) or the original [Ajax Framework](https://wintercms.com/docs/v1.2/docs/ajax/introduction) to be included in your layout or page in order to handle form requests.
1118

19+
## Installation
20+
21+
This plugin is available for installation via [Composer](http://getcomposer.org/).
22+
23+
```bash
24+
composer require winter/wn-user-plugin
25+
```
26+
27+
After installing the plugin you will need to run the migrations and (if you are using a [public folder](https://wintercms.com/docs/develop/docs/setup/configuration#using-a-public-folder)) [republish your public directory](https://wintercms.com/docs/develop/docs/console/setup-maintenance#mirror-public-files).
28+
29+
```bash
30+
php artisan migrate
31+
```
32+
1233
## Managing users
1334

1435
Users are managed on the Users tab found in the back-end. Each user provides minimal data fields - **Name**, **Surname**, **Email** and **Password**. The Name can represent either the person's first name or their full name, making the Surname field optional, depending on the complexity of your site.

0 commit comments

Comments
 (0)