Date: Tue, 18 Nov 2025 00:02:00 -0700
Subject: [PATCH] readme
---
.gitignore | 3 ++
LICENSE | 8 ++++
README.md | 77 ++++++++++++++++++++++++----------
icons/1024x1024.png | Bin 235184 -> 0 bytes
icons/128x128.png | Bin 12193 -> 0 bytes
icons/16x16.png | Bin 685 -> 0 bytes
icons/24x24.png | Bin 1167 -> 0 bytes
icons/256x256.png | Bin 33955 -> 0 bytes
icons/32x32.png | Bin 1756 -> 0 bytes
icons/48x48.png | Bin 2985 -> 0 bytes
icons/512x512.png | Bin 87695 -> 0 bytes
icons/64x64.png | Bin 4470 -> 0 bytes
icons/icon.icns | Bin 500590 -> 0 bytes
icons/icon.ico | Bin 361102 -> 0 bytes
icons/icons/mac/icon.icns | Bin 798719 -> 1406495 bytes
icons/icons/png/1024x1024.png | Bin 389889 -> 817469 bytes
icons/icons/png/128x128.png | Bin 17085 -> 14653 bytes
icons/icons/png/16x16.png | Bin 796 -> 660 bytes
icons/icons/png/24x24.png | Bin 1416 -> 1164 bytes
icons/icons/png/256x256.png | Bin 49939 -> 54358 bytes
icons/icons/png/32x32.png | Bin 2139 -> 1720 bytes
icons/icons/png/48x48.png | Bin 3768 -> 3078 bytes
icons/icons/png/512x512.png | Bin 139806 -> 227394 bytes
icons/icons/png/64x64.png | Bin 5828 -> 4695 bytes
icons/icons/win/icon.ico | Bin 361102 -> 361102 bytes
newicon.png | Bin 171701 -> 0 bytes
openscreen.png | Bin 0 -> 729852 bytes
preview.png | Bin 0 -> 571523 bytes
preview2.png | Bin 0 -> 305233 bytes
preview3.png | Bin 0 -> 205842 bytes
test.png | Bin 77422 -> 0 bytes
31 files changed, 66 insertions(+), 22 deletions(-)
create mode 100644 LICENSE
delete mode 100644 icons/1024x1024.png
delete mode 100644 icons/128x128.png
delete mode 100644 icons/16x16.png
delete mode 100644 icons/24x24.png
delete mode 100644 icons/256x256.png
delete mode 100644 icons/32x32.png
delete mode 100644 icons/48x48.png
delete mode 100644 icons/512x512.png
delete mode 100644 icons/64x64.png
delete mode 100644 icons/icon.icns
delete mode 100644 icons/icon.ico
delete mode 100644 newicon.png
create mode 100644 openscreen.png
create mode 100644 preview.png
create mode 100644 preview2.png
create mode 100644 preview3.png
delete mode 100644 test.png
diff --git a/.gitignore b/.gitignore
index 4108b33..ea2ff9e 100644
--- a/.gitignore
+++ b/.gitignore
@@ -22,3 +22,6 @@ dist-ssr
*.njsproj
*.sln
*.sw?
+release/**
+
+# npx electron-builder --mac --win
\ No newline at end of file
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000..4513941
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,8 @@
+OpenScreen Free Use License
+Copyright (c) 2025 Siddharth Vaddem
+
+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.
diff --git a/README.md b/README.md
index f02aedf..08afd3c 100644
--- a/README.md
+++ b/README.md
@@ -1,30 +1,63 @@
-# React + TypeScript + Vite
-This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.
-Currently, two official plugins are available:
-- [@vitejs/plugin-react](https://github.com/vitejs/vite-plugin-react/blob/main/packages/plugin-react/README.md) uses [Babel](https://babeljs.io/) for Fast Refresh
-- [@vitejs/plugin-react-swc](https://github.com/vitejs/vite-plugin-react-swc) uses [SWC](https://swc.rs/) for Fast Refresh
+
+
+
-## Expanding the ESLint configuration
-If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:
+# OpenScreen
-- Configure the top-level `parserOptions` property like this:
+OpenScreen is your free, open-source alternative to Screen Studio (sort of).
-```js
-export default {
- // other rules...
- parserOptions: {
- ecmaVersion: 'latest',
- sourceType: 'module',
- project: ['./tsconfig.json', './tsconfig.node.json'],
- tsconfigRootDir: __dirname,
- },
-}
-```
-- Replace `plugin:@typescript-eslint/recommended` to `plugin:@typescript-eslint/recommended-type-checked` or `plugin:@typescript-eslint/strict-type-checked`
-- Optionally add `plugin:@typescript-eslint/stylistic-type-checked`
-- Install [eslint-plugin-react](https://github.com/jsx-eslint/eslint-plugin-react) and add `plugin:react/recommended` & `plugin:react/jsx-runtime` to the `extends` list
+If you don't want to pay $29/month for Screen Studio but want a much simpler version that does what most people seem to need, making beautiful product demos and walkthroughs, here's a free-to-use app for you. OpenScreen does not offer all Screen Studio features, but covers the basics well!
+
+Okay, let's be real: Screen Studio is an awesome product and this is definitely not a 1:1 clone. OpenScreen is a much simpler take, just the basics for folks who want control and don't want to pay. If you need all the fancy features, your best bet is to support Screen Studio (they really do a great job, haha). But if you just want something free (no gotchas) and open, this project does the job!
+
+OpenScreen is 100% free for personal and commercial use. Use it, remix it, build on it. (Just be cool and give a shoutout if you feel like it!)
+
+
+
+**⚠️ DISCLAIMER: This is very much in beta and might be buggy here and there (but hope you have a good experience!).**
+
+