Skip to content

Commit

Permalink
adding in standardized methods to the included features section
Browse files Browse the repository at this point in the history
  • Loading branch information
horeaporutiu committed Jan 19, 2024
1 parent 5656d9e commit a210260
Show file tree
Hide file tree
Showing 16 changed files with 72 additions and 33 deletions.
7 changes: 4 additions & 3 deletions examples/ai-image-generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,11 @@ Watch the video below for a demo, code walkthrough, and to learn how to set up t
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [drop event](https://developers.miro.com/docs/ui_boardui#drop-event)
- [openPanel(options)](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.ui.on('drop')](https://developers.miro.com/docs/ui_boardui#drop-event)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.createImage](https://developers.miro.com/docs/board_board#createimage)
- [draggable elements](https://developers.miro.com/docs/add-drag-and-drop-to-your-app#add-draggable-elements-to-the-app-panel)
- [zoomTo](https://developers.miro.com/docs/viewport_viewport#zoomto)
- [miro.board.viewport.zoomTo()](https://developers.miro.com/docs/viewport_viewport#zoomto)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
8 changes: 4 additions & 4 deletions examples/asset-search/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ This app shows how to implement asset searching and filtering by name and tags.
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [drop event](https://developers.miro.com/docs/ui_boardui#drop-event)
- [createImage](https://developers.miro.com/docs/board_board#createimage)
- [viewport.zoomTo](https://developers.miro.com/docs/viewport_viewport#zoomto)
- [openPanel(options)](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.ui.on('drop')](https://developers.miro.com/docs/ui_boardui#drop-event)
- [miro.board.createImage](https://developers.miro.com/docs/board_board#createimage)
- [miro.board.viewport.zoomTo](https://developers.miro.com/docs/viewport_viewport#zoomto)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [draggable elements](https://developers.miro.com/docs/add-drag-and-drop-to-your-app#add-draggable-elements-to-the-app-panel)

# 🛠️ Tools and Technologies <a name="tools"></a>
Expand Down
6 changes: 3 additions & 3 deletions examples/blob-maker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ https://github.com/miroapp/app-examples/assets/10428517/b9d570ce-a0b4-4f2e-a8e6-
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [drop event](https://developers.miro.com/docs/ui_boardui#drop-event)
- [createImage](https://developers.miro.com/docs/board_board#createimage)
- [openPanel(options)](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.ui.on('drop')](https://developers.miro.com/docs/ui_boardui#drop-event)
- [miro.board.createImage](https://developers.miro.com/docs/board_board#createimage)
- [miro.board.ui.openPanel(options)](https://developers.miro.com/docs/ui_boardui#openpanel)
- [draggable elements](https://developers.miro.com/docs/add-drag-and-drop-to-your-app#add-draggable-elements-to-the-app-panel)

# 🛠️ Tools and Technologies <a name="tools"></a>
Expand Down
4 changes: 2 additions & 2 deletions examples/calendar/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ This app allows you to create a calendar consisting of shapes and text for the g
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [createShape()](https://developers.miro.com/docs/board_board#createshape)
- [createText()](https://developers.miro.com/docs/board_board#createtext)
- [miro.board.createShape()](https://developers.miro.com/docs/board_board#createshape)
- [miro.board.createText()](https://developers.miro.com/docs/board_board#createtext)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
9 changes: 8 additions & 1 deletion examples/connect-firebase/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,14 @@ https://github.com/miroapp/app-examples/assets/10800544/a0aaea4a-a95c-42f5-abb3-
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [Drag and Drop](https://developers.miro.com/docs/add-drag-and-drop-to-your-app)
- [miro.board.createShape()](https://developers.miro.com/docs/board_board#createshape)
- [miro.board.createText()](https://developers.miro.com/docs/board_board#createtext)
- [miro.board.createStickyNote()](https://developers.miro.com/docs/websdk-reference-board#createstickynote)
- [miro.board.createFrame()](https://developers.miro.com/docs/websdk-reference-board#createframe)
- [miro.board.createCard()](https://developers.miro.com/docs/websdk-reference-board#createcard)
- [miro.board.getUserInfo()](https://developers.miro.com/docs/websdk-reference-board#getuserinfo)
- [miro.board.getSelection()](https://developers.miro.com/docs/websdk-reference-board#getselection)
- [miro.board.ui.on("drop")](https://developers.miro.com/docs/ui_boardui#drop-event)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
4 changes: 2 additions & 2 deletions examples/csv-to-mindmap/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ Watch the short video (48 seconds) below to gain a quick overview of using the a
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [createMindMapNode()](https://developers.miro.com/docs/experimental_experimental#createmindmapnode)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.experimental.createMindmapNode()](https://developers.miro.com/docs/experimental_experimental#createmindmapnode)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
7 changes: 6 additions & 1 deletion examples/custom-actions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,12 @@ https://github.com/miroapp/app-examples/assets/10800544/4cd2c24b-877a-4ac0-a512-
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [Custom Actions](https://developers.miro.com/docs/action_customactionmanagement)
- [miro.board.notifications.showInfo()](https://developers.miro.com/docs/websdk-reference-notifications#showinfo)
- [miro.board.getInfo()](https://developers.miro.com/docs/websdk-reference-board#getinfo)
- [miro.board.createText()](https://developers.miro.com/docs/board_board#createtext)
- [miro.board.createStickyNote()](https://developers.miro.com/docs/websdk-reference-board#createstickynote)
- [miro.board.viewport.zoomTo()](https://developers.miro.com/docs/websdk-reference-viewport#zoomto)
- [Custom Actions](https://developers.miro.com/docs/action_customactionmanagement)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
5 changes: 3 additions & 2 deletions examples/digital-asset-manager/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,9 @@ https://github.com/miroapp/app-examples/assets/10800544/5eb60feb-1378-4691-a9dd-
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [drop event](https://developers.miro.com/docs/ui_boardui#drop-event)
- [openPanel(options)](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.ui.on('drop')](https://developers.miro.com/docs/ui_boardui#drop-event)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.createImage](https://developers.miro.com/docs/board_board#createimage)
- [draggable elements](https://developers.miro.com/docs/add-drag-and-drop-to-your-app#add-draggable-elements-to-the-app-panel)
- [Search and filter](https://developers.miro.com/docs/adding-search-and-filter-to-an-sdk-app)
- [Mirotone.xyz](https://www.mirotone.xyz/)
Expand Down
4 changes: 2 additions & 2 deletions examples/drag-and-drop/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ https://github.com/horeaporutiu/app-examples-template/assets/10428517/3e9aa5ea-0
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [drop event](https://developers.miro.com/docs/ui_boardui#drop-event)
- [openPanel(options)](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.ui.on('drop')](https://developers.miro.com/docs/ui_boardui#drop-event)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [draggable elements](https://developers.miro.com/docs/add-drag-and-drop-to-your-app#add-draggable-elements-to-the-app-panel)

# 🛠️ Tools and Technologies <a name="tools"></a>
Expand Down
15 changes: 15 additions & 0 deletions examples/enterprise-team-management/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,22 @@ https://github.com/miroapp/app-examples/assets/10800544/6096bd94-b0a2-46bf-a01f-
# ⚙️ Included Features <a name="features"></a>

- [Miro REST API](https://developers.miro.com/reference/api-reference)

- /GET [https://api.miro.com/v1/oauth-token](https://developers.miro.com/reference/get-access-token-context)

- [Miro Enterprise REST APIs](https://developers.miro.com/reference/enterprise-create-team)
- /GET [https://api.miro.com/v2/orgs/{org_id}](https://developers.miro.com/reference/enterprise-get-organization)
<!-- - /GET [https://api.miro.com/v2/teams_settings/{team_id}](https://developers.miro.com/reference/enterprise-get-team-settings) -->
- /GET [https://api.miro.com/v2/orgs/{org_id}/teams] i.e. List Teams API (https://developers.miro.com/reference/enterprise-get-teams)
- /GET [https://api.miro.com/v2/orgs/{org_id}/teams/{team_id}/members] i.e. List Team Members API (https://developers.miro.com/reference/enterprise-get-team-members)
- /POST [https://api.miro.com/v2/orgs/{org_id}/teams] i.e. Create Team API (https://developers.miro.com/reference/enterprise-create-team)
- /POST [https://api.miro.com/v2/orgs/{org_id}/teams/{team_id}/members] i.e. Invite Team Members API (https://developers.miro.com/reference/enterprise-invite-team-member)
- /PATCH [https://api.miro.com/v2/orgs/{org_id}/teams/{team_id}/members/{member_id}] i.e. Update Team Members API (https://developers.miro.com/reference/enterprise-update-team-member)
- /DELETE [https://api.miro.com/v2/orgs/{org_id}/teams/{team_id}/members/{member_id}] i.e. Delete team member from team API (https://developers.miro.com/reference/enterprise-delete-team-member)
- /DELETE [https://api.miro.com/v2/orgs/{org_id}/teams/{team_id}] i.e. Delete team API (https://developers.miro.com/reference/enterprise-delete-team)
- /POST [https://api.miro.com/v2/boards] i.e. Create Board API (https://developers.miro.com/reference/create-board)
- /POST [https://api.miro.com/v2/boards/{board_id}/sticky_notes] i.e. Create Sticky Note API (https://developers.miro.com/reference/create-sticky-note-item)
- /GET [https://api.miro.com/v2/orgs/{org_id}/teams] i.e. List Teams API (https://developers.miro.com/reference/enterprise-get-teams)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
6 changes: 3 additions & 3 deletions examples/nextjs-full-stack/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ https://github.com/miroapp/app-examples/assets/10428517/1bc9e8e0-48bd-43c2-8ba2-
- [board.createImageItem](https://miroapp.github.io/api-clients/classes/index.Board.html#createImageItem)
- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [icon:click event](https://developers.miro.com/docs/ui_boardui#iconclick-event)
- [getInfo()](https://developers.miro.com/docs/board_board#getinfo)
- [openModal()](https://developers.miro.com/docs/ui_boardui#openmodal)
- [openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.getInfo()](https://developers.miro.com/docs/board_board#getinfo)
- [miro.board.ui.openModal()](https://developers.miro.com/docs/ui_boardui#openmodal)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
2 changes: 2 additions & 0 deletions examples/python-flask-starter-with-oauth/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@ https://github.com/miroapp/app-examples/assets/10800544/767dba77-c3dd-40b0-b6d7-
# ⚙️ Included Features <a name="features"></a>

- [Miro REST API](https://developers.miro.com/reference/api-reference)
- [GET /boards](https://developers.miro.com/reference/get-boards)
- [Miro OAuth2.0](https://developers.miro.com/docs/getting-started-with-oauth)
- [GET https://api.miro.com/v1/oauth-token](https://developers.miro.com/reference/get-access-token-context)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
8 changes: 8 additions & 0 deletions examples/selfie-with-custom-action/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,14 @@ https://github.com/miroapp/app-examples/assets/7162412/46b1708d-fb08-412e-a7b2-3
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)

- [miro.board.getById()](https://developers.miro.com/docs/websdk-reference-board#getbyid)
- [miro.board.viewport.get()](https://developers.miro.com/docs/websdk-reference-viewport#get)
- [miro.board.viewport.zoomTo()](https://developers.miro.com/docs/websdk-reference-viewport#zoomto)
- [miro.board.createImage()](https://developers.miro.com/docs/board_board#createimage)
- [miro.board.ui.closeModal()](https://developers.miro.com/docs/websdk-reference-ui#closemodal)
- [miro.board.ui.openModal()](https://developers.miro.com/docs/websdk-reference-ui#openmodal)

- [Custom Actions](https://developers.miro.com/docs/action_customactionmanagement)

# 🛠️ Tools and Technologies <a name="tools"></a>
Expand Down
6 changes: 3 additions & 3 deletions examples/stickynotes-to-shapes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ This app shows how you can select items on the board, and then click the app ico
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [getSelection()](https://developers.miro.com/docs/board_board#getselection)
- [remove()](https://developers.miro.com/docs/board_board#remove)
- [createShape()](https://developers.miro.com/docs/board_board#createshape)
- [miro.board.getSelection()](https://developers.miro.com/docs/board_board#getselection)
- [miro.board.remove()](https://developers.miro.com/docs/board_board#remove)
- [miro.board.createShape()](https://developers.miro.com/docs/board_board#createshape)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
6 changes: 3 additions & 3 deletions examples/template-builder/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,9 @@ https://github.com/miroapp/app-examples/assets/10428517/24aacae3-5183-4142-bdae-
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [createText()](https://developers.miro.com/docs/board_board#createtext)
- [createShape()](https://developers.miro.com/docs/board_board#createshape)
- [openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.createText()](https://developers.miro.com/docs/board_board#createtext)
- [miro.board.createShape()](https://developers.miro.com/docs/board_board#createshape)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down
8 changes: 4 additions & 4 deletions examples/wordle/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,11 @@ https://github.com/miroapp/app-examples/assets/10428517/56fe0932-2608-47ae-9e08-
# ⚙️ Included Features <a name="features"></a>

- [Miro Web SDK](https://developers.miro.com/docs/web-sdk-reference)
- [createStickyNote()](https://developers.miro.com/docs/board_board#createstickynote)
- [getById()](https://developers.miro.com/docs/board_board#getbyid)
- [miro.board.createStickyNote()](https://developers.miro.com/docs/board_board#createstickynote)
- [miro.board.getById()](https://developers.miro.com/docs/board_board#getbyid)
- [remove()](https://developers.miro.com/docs/board_board#remove)
- [viewport.get()](https://developers.miro.com/docs/viewport_viewport#get)
- [openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)
- [miro.board.viewport.get()](https://developers.miro.com/docs/viewport_viewport#get)
- [miro.board.ui.openPanel()](https://developers.miro.com/docs/ui_boardui#openpanel)

# 🛠️ Tools and Technologies <a name="tools"></a>

Expand Down

0 comments on commit a210260

Please sign in to comment.