commun - npm Package Compare versions

Comparing version 0.3.3 to 0.3.4

package.json

 {
   "name": "commun",
-  "version": "0.3.3",
-  "description": "🎩 Zero-code platform for creating scalable backends for communities and user based apps",
+  "version": "0.3.4",
+  "description": "🎩 No-code platform for creating scalable backends for communities and user based apps",
   "repository": {
@@ -6,0 +6,0 @@ "type": "git",

README.md

@@ -45,34 +45,12 @@ # Commun
 
-## Features
+## Dashboard
 
-### User Management
+![Commun Dashboard](https://i.imgur.com/OfssVs1.png)
 
-Commun includes a fully featured user system with authentication and permission management.
+Commun comes with a complete dashboard that you can use to manage your application without having to write any code.
 
-Supported authentication strategies include: Email & Password, Google, Facebook and GitHub.
+The dashboard also works perfectly on mobile devices, so you can manage your app on the go.
 
-**Provided APIs:**
+## Documentation
 
-* `[POST] /api/v1/auth/password`
-  - Creates a new user with email, username and password
-  - Sends an email with a code to verify the email 
-
-* `[POST] /api/v1/auth/password/login`
-  - Authenticates an user with email/username and password
-  - Returns refresh and access token
-
-* `[POST] /api/v1/auth/token`
-  - Returns an access token given a refresh token
-
-* `[POST] /api/v1/auth/verify`
-  - Verifies an user's email given the code sent after registration
-
-* `[POST] /api/v1/auth/password/forgot`
-  - Sends a forgot password code by email
-
-* `[POST] /api/v1/auth/password/reset`
-  - Allows to change a password, given a valid forgot password code
-
-Users are entities, so you can also use all the APIs specified bellow, where `:entity` is `users`
-
 ### Entities
@@ -165,12 +143,34 @@
 
-### Dashboard
+### User Management
 
-![Commun Dashboard](https://i.imgur.com/OfssVs1.png)
+Commun includes a fully featured user system with authentication and permission management.
 
-Commun comes with a complete dashboard that you can use to manage your application without having to write any code.
+Supported authentication strategies include: Email & Password, Google, Facebook and GitHub.
 
-The dashboard also works perfectly on mobile devices, so you can manage your app on the go.
+**Provided APIs:**
 
-### Production readiness
+* `[POST] /api/v1/auth/password`
+  - Creates a new user with email, username and password
+  - Sends an email with a code to verify the email 
 
+* `[POST] /api/v1/auth/password/login`
+  - Authenticates an user with email/username and password
+  - Returns refresh and access token
+
+* `[POST] /api/v1/auth/token`
+  - Returns an access token given a refresh token
+
+* `[POST] /api/v1/auth/verify`
+  - Verifies an user's email given the code sent after registration
+
+* `[POST] /api/v1/auth/password/forgot`
+  - Sends a forgot password code by email
+
+* `[POST] /api/v1/auth/password/reset`
+  - Allows to change a password, given a valid forgot password code
+
+Users are entities, so you can also use all the entity APIs replacing `:entity` with `users`
+
+## Production readiness
+
 All the configuration used by Commun is stored in json files, which are updated by the dashboard.
@@ -177,0 +177,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Worsened metrics

Total package byte prevSize

7537

decreased by-0.05%

No dependency changes