Skip to content

Commit cb1de2a

Browse files
committed
chore: Update documentation about the package.
1 parent e26d01c commit cb1de2a

File tree

3 files changed

+30
-14
lines changed

3 files changed

+30
-14
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
* Add @release-it/conventional-changelog. ([108e76f](https://github.com/collective/volto-authomatic/commit/108e76fc54619854693d435f36ede484d253d58d))
77

8-
## 1.0.0 (2021+08+18)
8+
## 1.0.0 (2021-08-18)
99

1010
### Feature
1111

README.md

Lines changed: 29 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,25 @@
11
# Social Login for Volto (volto-authomatic)
22

3-
43
Addon implementing Social Login in Volto sites. It requires [pas.plugins.authomatic](https://github.com/collective/pas.plugins.authomatic/), version 1.0b2 or superior, to be installed and configured on the Plone backend.
54

6-
## Install
5+
[![Code analysis checks](https://github.com/collective/volto-authomatic/actions/workflows/code.yml/badge.svg)](https://github.com/collective/volto-authomatic/actions/workflows/code.yml)
6+
[![Unit tests](https://github.com/collective/volto-authomatic/actions/workflows/unit.yml/badge.svg)](https://github.com/collective/volto-authomatic/actions/workflows/unit.yml)
77

8-
If you already have a Volto project, just update `package.json`:
8+
## Screenshots
99

10-
```JSON
11-
"addons": [
12-
"volto-authomatic"
13-
],
10+
### Login Form
11+
<img alt="Login Form" src="./docs/login-form.png" width="500" />
1412

15-
"dependencies": {
16-
"volto-authomatic": "*"
17-
}
18-
```
13+
## Examples
14+
volto-authomatic can be seen in action at the following sites:
15+
16+
- 2021 Plone Conference: https://2021.ploneconf.org
17+
18+
## Install
1919

20-
If not, create one:
20+
### New Volto Project
2121

22+
Create a Volto project
2223
```shell
2324
npm install -g yo @plone/generator-volto
2425
yo @plone/volto my-volto-project --addon volto-authomatic
@@ -32,4 +33,19 @@ yarn install
3233
yarn start
3334
```
3435

35-
Go to http://localhost:3000
36+
### Existing Volto Project
37+
If you already have a Volto project, just update `package.json`:
38+
39+
```JSON
40+
"addons": [
41+
"volto-authomatic"
42+
],
43+
44+
"dependencies": {
45+
"volto-authomatic": "*"
46+
}
47+
```
48+
49+
### Test it
50+
51+
Go to http://localhost:3000/login

docs/login-form.png

38 KB
Loading

0 commit comments

Comments
 (0)