prozilla-os 1.0.13 → 1.0.14

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.
Files changed (2) hide show
  1. package/README.md +22 -2
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -13,7 +13,9 @@
13
13
 
14
14
  ## About
15
15
 
16
- `prozilla-os` is a React component library written in TypeScript for building web-based operating systems, made by Prozilla.
16
+ `prozilla-os` is a React Vite component library written in TypeScript for building web-based operating systems, made by Prozilla. This package combines multiple other packages for easy access to different ProzillaOS features. You can also download these packages separately instead.
17
+
18
+ **Live demo: [os.prozilla.dev][website]** - [(source)][website-source]
17
19
 
18
20
  ## Installation
19
21
 
@@ -23,8 +25,21 @@ $ yarn add prozilla-os
23
25
  $ pnpm add prozilla-os
24
26
  ```
25
27
 
28
+ ## Packages
29
+
30
+ `prozilla-os` combines the following packages into one:
31
+
32
+ - [`@prozilla-os/core`][core] - Core functionality, React components and hooks
33
+ - [`@prozilla-os/file-explorer`][file-explorer] - File explorer app
34
+ - [`@prozilla-os/terminal`][terminal] - Terminal/shell app
35
+ - [`@prozilla-os/text-editor`][text-editor] - Text editor app
36
+
26
37
  ## Usage
27
38
 
39
+ For more information about the in-depth usage of each package, check out the links in the section above.
40
+
41
+ ### Basic setup
42
+
28
43
  ```tsx
29
44
  import { Desktop, ModalsView, ProzillaOS, Taskbar, WindowsView } from "prozilla-os";
30
45
 
@@ -158,6 +173,11 @@ function App() {
158
173
  - [Ko-fi][ko-fi]
159
174
 
160
175
  [website]: https://os.prozilla.dev/
176
+ [website-source]: https://github.com/prozilla-os/ProzillaOS
161
177
  [github]: https://github.com/prozilla-os/ProzillaOS/tree/convert-to-monorepo/packages/prozilla-os
162
178
  [npm]: https://www.npmjs.com/package/prozilla-os
163
- [ko-fi]: https://ko-fi.com/prozilla
179
+ [ko-fi]: https://ko-fi.com/prozilla
180
+ [core]: https://www.npmjs.com/package/@prozilla-os/core
181
+ [file-explorer]: https://www.npmjs.com/package/@prozilla-os/file-explorer
182
+ [terminal]: https://www.npmjs.com/package/@prozilla-os/terminal
183
+ [text-editor]: https://www.npmjs.com/package/@prozilla-os/text-editor
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "prozilla-os",
3
3
  "description": "a React component library written in TypeScript for building web-based operating systems, made by Prozilla.",
4
- "version": "1.0.13",
4
+ "version": "1.0.14",
5
5
  "homepage": "https://os.prozilla.dev",
6
6
  "author": {
7
7
  "name": "Prozilla",
@@ -20,10 +20,10 @@
20
20
  "dependencies": {
21
21
  "@fortawesome/fontawesome-svg-core": "^6.5.2",
22
22
  "react-ga4": "^2.1.0",
23
- "@prozilla-os/core": "1.0.13",
24
- "@prozilla-os/file-explorer": "1.0.10",
25
- "@prozilla-os/terminal": "1.0.3",
26
- "@prozilla-os/text-editor": "1.0.3"
23
+ "@prozilla-os/core": "1.0.14",
24
+ "@prozilla-os/file-explorer": "1.0.11",
25
+ "@prozilla-os/terminal": "1.0.4",
26
+ "@prozilla-os/text-editor": "1.0.4"
27
27
  },
28
28
  "devDependencies": {
29
29
  "@types/node": "^20.14.5",