@sesamy/sesamy-js 1.34.6 → 1.35.0

package/README.md

@@ -18,6 +18,9 @@ The following events are tracked:
 
 The following methods are available on the `sesamy` object:
 
+- amendments
+  - create: create an amendment to a contract
+  - confirm: confirms a created amendment for a contract.
 - attributions
   - get: get the attributions for a user
   - set: set the attributions for a user
@@ -168,6 +171,43 @@ These are the available configuration options, with their default values:
 }
 ```
 
+# Custom HTML Attributes
+
+## Visibility
+
+### Overview
+
+The `sesamy-visibility` attribute allows dynamic visibility control of HTML elements based on the authentication state of a user.
+
+### Usage
+
+This attribute can be added to HTML elements to automatically show or hide them based on authentication status.
+
+#### Example
+
+```html
+<div sesamy-visibility="logged-in">Welcome, User!</div>
+<div sesamy-visibility="not-logged-in">Please log in.</div>
+```
+
+## Links
+
+### Overview
+
+The `sesamy-link` attribute attaches a click handler to an element that redirects the user.
+
+### Usage
+
+This attribute can be added to HTML elements to redirect the user to the following targets: `login`, `logout` and `account`.
+
+#### Example
+
+```html
+<div sesamy-link="login">Login</div>
+<div sesamy-link="logout">Logout</div>
+<div sesamy-link="account">Account</div>
+```
+
 # Auth API
 
 ## `isAuthenticated()`