Skip to content

Commit

Permalink
docs: update
Browse files Browse the repository at this point in the history
  • Loading branch information
andrepolischuk committed Apr 15, 2024
1 parent 26753c6 commit 0088f61
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Widgetly

Library helps you to create widgets, including widgets that work via an iframe.
Library that helps you to create widgets, including widgets that work via an iframe.

## Main goals

* Reusable Widgets: extract some business logic into a universal widget, which can then be easily reused across various applications. A single widget can be integrated into numerous applications without the need to change its code.
* Reusable widgets: extract some business logic into a universal widget, which can then be easily reused across various applications. A single widget can be integrated into numerous applications without the need to change its code.
* API: create an external interface for interacting with the widget, that provides for developers methods to control the widget, receive data from it, and send data to the widget.
* Transport: use built-in mechanism for sync data and methods between the application, widget, and iframe, without using `postMessage` directly.
* Framework agnostic: use any libraries and frameworks to create widgets and applications that embed them, increasing flexibility and development speed.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "widgetly",
"version": "6.1.1",
"description": "Library helps you to create widgets, including widgets that work via an iframe",
"description": "Library that helps you to create widgets, including widgets that work via an iframe",
"main": "dist/index.js",
"module": "dist/index.js",
"types": "dist/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"extends": "@rambler-tech/typedoc-config",
"customTitle": "Widgetly",
"customDescription": "Library helps you to create iframe widgets",
"customDescription": "Library that helps you to create widgets, including widgets that work via an iframe",
"readme": "README.md",
"entryPoints": ["src/index.ts"],
"out": "public",
Expand Down

0 comments on commit 0088f61

Please sign in to comment.