Skip to content

Commit

Permalink
Minor README cleanups
Browse files Browse the repository at this point in the history
  • Loading branch information
Posnet committed Jun 23, 2021
1 parent 98c5065 commit 09ff942
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# PopOut!
# [PopOut!](https://foundryvtt.com/packages/popout)

This Foundry VTT module lets you pop out actor sheets and journal entries into their own windows.

Expand All @@ -12,19 +12,20 @@ As DM go to the `Manage Modules` options menu in your Game Settings tab then ena
# Module Developers
Popout! exposes a single API function and a series of hooks so other modules can leverage it's functionality.

This API is new as of version 2.0, and I will strive to maintain API compatibility from this point on.
This API is new as of version 2.0, with the goal is to maintain API compatibility from this point on.

*Note*: There was a minor compatibility break which is why 2.0 was released, the PopOut hook now only takes 2 arguments instead of 3.

To PopOut an application call the function with the application object.
To pop out an application, call the function with the application object.

```js
// Where app is the top level Application foundry object.
// Where app is the foundry Application object. For example an actor sheet.
// If the Application exists in the window.ui.windows map, it should be able to be popped out.
PopoutModule.popoutApp(app);
```

PopOut also exposes hooks to developers to alter its behavior to add compatibility to their modules.
For an example of what that might look like, see the PDFoundry compatibility hooks in [./popout.js#675](./popout.js#675)
For an example of what that might look like, see the PDFoundry compatibility hooks in [./popout.js](./popout.js#697)

```javascript
// app: is the foundry application being popped out.
Expand Down Expand Up @@ -54,5 +55,4 @@ It is currently maintained by @Posnet.

This work is licensed under Foundry Virtual Tabletop [EULA - LIMITED LICENSE AGREEMENT FOR MODULE DEVELOPMENT](https://foundryvtt.com/article/license/)

It the contents of this module are licensed under a [Creative Commons Attribution 4.0 International License](./LICENSE.txt) where they do not conflict with the above Foundry License.

The contents of this module are licensed under a [Creative Commons Attribution 4.0 International License](./LICENSE.txt) where they do not conflict with the above Foundry License.

0 comments on commit 09ff942

Please sign in to comment.