web-window-manager 1.0.7 → 1.0.9

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Triston Armstrong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,41 +1,43 @@
+<!-- PSA SECTION _____________________________ -->
+
 # PSA
+
 THIS PACKAGE IS NOT READY FOR USE IN YOUR PROJECTS
 
-<br/>
+
+<!-- TODO SECTION _____________________________ -->
 
 # TODO
+
 - [x] Add appropriate readme boilerplate
 - [ ] Add complete readme details
 - [ ] Add examples
 - [ ] abstract cache manager to new npm package
 
-<br/>
+
+<!-- MAIN SECTION INTRO _____________________________ -->
 
 # Web-Window-Manager
 
-TODO: put descriptino here
+A Window Manger for managing the creation and deletion of windows/tabs within a web based application.
+
 
-### Badges
+<!-- BADGES SECTION _____________________________ -->
 
-[![current version](https://img.shields.io/npm/v/storybook-addon-next.svg)](https://www.npmjs.com/package/storybook-addon-next)
+## Badges
 
-TODO: add release detials here
+[![npm version](https://img.shields.io/npm/v/npm.svg)](https://npm.im/npm)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Release](https://github.com/Tarmstrong95/component-test-helper/actions/workflows/release-package.yml/badge.svg)](https://github.com/Tarmstrong95/component-test-helper/actions/workflows/release-package.yml)
 
 <div id="top"></div>
 
-### Externals
+<hr/>
 
-[![Contributors][contributors-shield]][contributors-url]
-[![Forks][forks-shield]][forks-url]
-[![Stargazers][stars-shield]][stars-url]
-[![Issues][issues-shield]][issues-url]
-[![MIT License][license-shield]][license-url]
-[![LinkedIn][linkedin-shield]][linkedin-url]
+<!-- TABLE OF CONTENTS SECTION _____________________________ -->
 
-<!-- PROJECT LOGO -->
-<br />
+## Table Of Contents
 
-<!-- TABLE OF CONTENTS -->
 <details>
   <summary>Table of Contents</summary>
   <ol>
@@ -61,87 +63,137 @@ TODO: add release detials here
   </ol>
 </details>
 
-<br/>
+<hr/>
 
-<!-- ABOUT THE PROJECT -->
+<!-- ABOUT SECTION _____________________________ -->
 
 ## About The Project
 
-TODO: put about the project here
+This package allows developers to build applications that can open windows/tabs at an infinite depth (theoretically) and close all windows/tabs, based on some "event", that are "children" of the window/tab that triggered the event. This solves the problem some web applications have with persistence and ensuring all children are closed given various edge cases.
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+- EVENT: a button click, hot key, or anything else (fully customizable)
+- CHILDREN: a window/tab that was opened by a given window/tab
+
+<!-- BUILT WITH SECTION _____________________________ -->
 
 ### Built With
 
 - [TypeScript](https://www.typescriptlang.org/)
+- [Lodash](https://lodash.com/)
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+<!-- GETTING STARTED SECTION _____________________________ -->
 
-<!-- GETTING STARTED -->
+<hr/>
 
 ## Getting Started
 
-To get the package included in your project, follow these steps
+To get started with the `Web-Window-Manager`, you will need to have the following prerequisites installed:
 
-### Installation
+- Node.js
+- [npm](https://www.npmjs.com/) (comes with Node.js)
 
-using [npm](https://www.npmjs.com/):
+Once you have these prerequisites installed, you can proceed to install the Web-Window-Manager package using npm:
 
 ```bash
 npm i web-window-manager
 ```
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+After installing the package, you can import and use it in your project as shown in the Usage section above.
+
+<hr/>
 
-<!-- USAGE EXAMPLES -->
+<!-- USAGE SECTION _____________________________ -->
 
 ## Usage
+Import the Web-Window-Manager file into your entry file (e.g. app.tsx in a React project):
+   
 
-TODO: Add how to use this package
+```typescript
+import 'web-window-manager';
+```
 
+Replace any window.open() calls in your code with window.windowManager.open():
+```typescript
+// Before
+window.open('https://www.example.com', '_blank');
 
-_Check out the [examples](https://github.com/Tarmstrong95/WindowManger/tree/main/src/examples) folder for more details_
+// After
+window.windowManager.open('https://www.example.com', '_blank');
+```
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+This will use the Web-Window-Manager to open the new window/tab, allowing you to track and manage it within your application.
 
-<hr>
+Add a simple React button with an onClick prop that calls window.windowManager.recursivelyCloseChildren() with a label of "Logout":
 
-See the [open issues](https://github.com/Tarmstrong95/WebWindowManager/issues) for a full list of proposed features (and known issues).
+```javascript
+import 'web-window-manager';
 
-<!-- CONTRIBUTING -->
+// Initialize the window manager with a custom event
+const windowManager = new WebWindowManager('custom-event');
 
-## Contributing
+function App() {
+  return (
+    <button onClick={() => window.windowManager.recursivelyCloseChildren()}>
+      Logout
+    </button>
+  );
+}
 
-Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
+```
 
-If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".
-Don't forget to give the project a star! Thanks again!
+When the user clicks the "Logout" button, this will close all child windows/tabs that were opened by the current window/tab.
 
-1. Fork the Project
-2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
-3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
-4. Push to the Branch (`git push origin feature/AmazingFeature`)
-5. Open a Pull Request
+For more detailed usage instructions and examples, please see the `Web-Window-Manager` documentation [examples](https://github.com/Tarmstrong95/WindowManger/tree/main/src/examples).
 
-<p align="right">(<a href="#top">back to top</a>)</p>
 
-<!-- LICENSE -->
 
-## License
+_See the [open issues](https://github.com/Tarmstrong95/WebWindowManager/issues) for a full list of proposed features (and known issues)._
 
-Distributed under the MIT License. See `LICENSE.txt` for more information.
+<hr/>
+
+<!-- ROADMAP SECTION _____________________________ -->
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+## Roadmap
 
-<!-- CONTACT -->
+1. The Web-Window-Manager package is still in development, and the following features are planned for future releases:
 
+1. Abstract the cache manager to a separate npm package
+   Add more detailed examples and usage instructions in the readme
+
+<hr/>
+
+<!-- CONTRIBUTING SECTION _____________________________ -->
+
+## Contributing
+
+If you would like to contribute to the development of the Web-Window-Manager package, please follow these steps:
+
+1. Fork the repository
+2. Create a new branch for your changes (e.g. feature/new-feature)
+3. Make your changes and commit them to your branch
+4. Push your branch to your forked repository
+5. Open a new pull request from your branch to the master branch of the original repository
+
+<hr/>
+<!-- LICENSE SECTION _____________________________ -->
+## License
+
+Distributed under the MIT License. See `LICENSE.txt` for more information.
+
+<hr/>
+<!-- CONTACT SECTION _____________________________ -->
 ## Contact
 
 Me - [@Triston08227721](https://twitter.com/Triston08227721) - triston95strong@gmail.com
 
 Project Link: [https://github.com/Tarmstrong95/WebWindowManager](https://github.com/Tarmstrong95/WebWindowManager)
 
-<p align="right">(<a href="#top">back to top</a>)</p>
+<!-- MARKDOWN LINKS & IMAGES -->
+
+### Acknowledgments
+
+- [Shields.io](https://shields.io/) for providing the badges used in the readme.
+- [Lodash](https://lodash.com/) for providing the utility functions used in the package.
 
 <!-- MARKDOWN LINKS & IMAGES -->
 <!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
@@ -157,4 +209,4 @@ Project Link: [https://github.com/Tarmstrong95/WebWindowManager](https://github.
 [license-shield]: https://img.shields.io/github/license/Tarmstrong95/WebWindowManager.svg?style=for-the-badge
 [license-url]: https://github.com/Tarmstrong95/WebWindowManager/blob/main/LICENSE
 [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
-[linkedin-url]: https://linkedin.com/in/triston95strong
+[linkedin-url]: https://linkedin.com/in/triston95strong

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "web-window-manager",
-  "version": "1.0.7",
+  "version": "1.0.9",
   "description": "A window manager for maintaining window parent child relationships",
   "main": "lib/index.js",
   "author": "Triston Armstrong",