web-window-manager 1.0.4 → 1.0.6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +159 -3
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,4 +1,160 @@
|
|
|
1
|
+
# PSA
|
|
2
|
+
THIS PACKAGE IS NOT READY FOR USE IN YOUR PROJECTS
|
|
3
|
+
|
|
4
|
+
<br/>
|
|
5
|
+
|
|
1
6
|
# TODO
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
7
|
+
- [x] Add appropriate readme boilerplate
|
|
8
|
+
- [ ] Add complete readme details
|
|
9
|
+
- [ ] Add examples
|
|
10
|
+
- [ ] abstract cache manager to new npm package
|
|
11
|
+
|
|
12
|
+
<br/>
|
|
13
|
+
|
|
14
|
+
# Web-Window-Manager
|
|
15
|
+
|
|
16
|
+
TODO: put descriptino here
|
|
17
|
+
|
|
18
|
+
### Badges
|
|
19
|
+
|
|
20
|
+
[](https://www.npmjs.com/package/storybook-addon-next)
|
|
21
|
+
|
|
22
|
+
TODO: add release detials here
|
|
23
|
+
|
|
24
|
+
<div id="top"></div>
|
|
25
|
+
|
|
26
|
+
### Externals
|
|
27
|
+
|
|
28
|
+
[![Contributors][contributors-shield]][contributors-url]
|
|
29
|
+
[![Forks][forks-shield]][forks-url]
|
|
30
|
+
[![Stargazers][stars-shield]][stars-url]
|
|
31
|
+
[![Issues][issues-shield]][issues-url]
|
|
32
|
+
[![MIT License][license-shield]][license-url]
|
|
33
|
+
[![LinkedIn][linkedin-shield]][linkedin-url]
|
|
34
|
+
|
|
35
|
+
<!-- PROJECT LOGO -->
|
|
36
|
+
<br />
|
|
37
|
+
|
|
38
|
+
<!-- TABLE OF CONTENTS -->
|
|
39
|
+
<details>
|
|
40
|
+
<summary>Table of Contents</summary>
|
|
41
|
+
<ol>
|
|
42
|
+
<li>
|
|
43
|
+
<a href="#about-the-project">About The Project</a>
|
|
44
|
+
<ul>
|
|
45
|
+
<li><a href="#built-with">Built With</a></li>
|
|
46
|
+
</ul>
|
|
47
|
+
</li>
|
|
48
|
+
<li>
|
|
49
|
+
<a href="#getting-started">Getting Started</a>
|
|
50
|
+
<ul>
|
|
51
|
+
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
52
|
+
<li><a href="#installation">Installation</a></li>
|
|
53
|
+
</ul>
|
|
54
|
+
</li>
|
|
55
|
+
<li><a href="#usage">Usage</a></li>
|
|
56
|
+
<li><a href="#roadmap">Roadmap</a></li>
|
|
57
|
+
<li><a href="#contributing">Contributing</a></li>
|
|
58
|
+
<li><a href="#license">License</a></li>
|
|
59
|
+
<li><a href="#contact">Contact</a></li>
|
|
60
|
+
<li><a href="#acknowledgments">Acknowledgments</a></li>
|
|
61
|
+
</ol>
|
|
62
|
+
</details>
|
|
63
|
+
|
|
64
|
+
<br/>
|
|
65
|
+
|
|
66
|
+
<!-- ABOUT THE PROJECT -->
|
|
67
|
+
|
|
68
|
+
## About The Project
|
|
69
|
+
|
|
70
|
+
TODO: put about the project here
|
|
71
|
+
|
|
72
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
73
|
+
|
|
74
|
+
### Built With
|
|
75
|
+
|
|
76
|
+
- [TypeScript](https://www.typescriptlang.org/)
|
|
77
|
+
|
|
78
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
79
|
+
|
|
80
|
+
<!-- GETTING STARTED -->
|
|
81
|
+
|
|
82
|
+
## Getting Started
|
|
83
|
+
|
|
84
|
+
To get the package included in your project, follow these steps
|
|
85
|
+
|
|
86
|
+
### Installation
|
|
87
|
+
|
|
88
|
+
using [npm](https://www.npmjs.com/):
|
|
89
|
+
|
|
90
|
+
```bash
|
|
91
|
+
npm i web-window-manager
|
|
92
|
+
```
|
|
93
|
+
|
|
94
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
95
|
+
|
|
96
|
+
<!-- USAGE EXAMPLES -->
|
|
97
|
+
|
|
98
|
+
## Usage
|
|
99
|
+
|
|
100
|
+
TODO: Add how to use this package
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
_Check out the [examples](https://github.com/Tarmstrong95/WindowManger/tree/main/src/examples) folder for more details_
|
|
104
|
+
|
|
105
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
106
|
+
|
|
107
|
+
<hr>
|
|
108
|
+
|
|
109
|
+
See the [open issues](https://github.com/Tarmstrong95/WebWindowManager/issues) for a full list of proposed features (and known issues).
|
|
110
|
+
|
|
111
|
+
<!-- CONTRIBUTING -->
|
|
112
|
+
|
|
113
|
+
## Contributing
|
|
114
|
+
|
|
115
|
+
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
|
|
116
|
+
|
|
117
|
+
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".
|
|
118
|
+
Don't forget to give the project a star! Thanks again!
|
|
119
|
+
|
|
120
|
+
1. Fork the Project
|
|
121
|
+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
|
|
122
|
+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
|
123
|
+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
|
124
|
+
5. Open a Pull Request
|
|
125
|
+
|
|
126
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
127
|
+
|
|
128
|
+
<!-- LICENSE -->
|
|
129
|
+
|
|
130
|
+
## License
|
|
131
|
+
|
|
132
|
+
Distributed under the MIT License. See `LICENSE.txt` for more information.
|
|
133
|
+
|
|
134
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
135
|
+
|
|
136
|
+
<!-- CONTACT -->
|
|
137
|
+
|
|
138
|
+
## Contact
|
|
139
|
+
|
|
140
|
+
Me - [@Triston08227721](https://twitter.com/Triston08227721) - triston95strong@gmail.com
|
|
141
|
+
|
|
142
|
+
Project Link: [https://github.com/Tarmstrong95/WebWindowManager](https://github.com/Tarmstrong95/WebWindowManager)
|
|
143
|
+
|
|
144
|
+
<p align="right">(<a href="#top">back to top</a>)</p>
|
|
145
|
+
|
|
146
|
+
<!-- MARKDOWN LINKS & IMAGES -->
|
|
147
|
+
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
|
|
148
|
+
|
|
149
|
+
[contributors-shield]: https://img.shields.io/github/contributors/Tarmstrong95/WebWindowManager.svg?style=for-the-badge
|
|
150
|
+
[contributors-url]: https://github.com/Tarmstrong95/WebWindowManager/graphs/contributors
|
|
151
|
+
[forks-shield]: https://img.shields.io/github/forks/Tarmstrong95/WebWindowManager.svg?style=for-the-badge
|
|
152
|
+
[forks-url]: https://github.com/Tarmstrong95/WebWindowManager/network/members
|
|
153
|
+
[stars-shield]: https://img.shields.io/github/stars/Tarmstrong95/WebWindowManager.svg?style=for-the-badge
|
|
154
|
+
[stars-url]: https://github.com/Tarmstrong95/WebWindowManager/stargazers
|
|
155
|
+
[issues-shield]: https://img.shields.io/github/issues/Tarmstrong95/WebWindowManager.svg?style=for-the-badge
|
|
156
|
+
[issues-url]: https://github.com/Tarmstrong95/WebWindowManager/issues
|
|
157
|
+
[license-shield]: https://img.shields.io/github/license/Tarmstrong95/WebWindowManager.svg?style=for-the-badge
|
|
158
|
+
[license-url]: https://github.com/Tarmstrong95/WebWindowManager/blob/main/LICENSE
|
|
159
|
+
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
|
|
160
|
+
[linkedin-url]: https://linkedin.com/in/triston95strong
|