@mercuryworkshop/scramjet 1.0.1 → 2.0.0-alpha

package/LICENSE

@@ -630,11 +630,11 @@ state the exclusion of warranty; and each file should have at least
 the "copyright" line and a pointer to where the full notice is found.
 
     <one line to give the program's name and a brief idea of what it does.>
-    Copyright (C) 2024  <name of author>
+    Copyright (C) <year>  <name of author>
 
     This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU Affero General Public License as published
-    by the Free Software Foundation, either version 3 of the License, or
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
     (at your option) any later version.
 
     This program is distributed in the hope that it will be useful,

package/README.md

@@ -1,21 +1,65 @@
-# Scramjet
-
-Scramjet is an experimental web proxy that aims to be the successor to Ultraviolet.
-
-It currently does not support most websites due to it being very early in the development stage.
-
-The UI is not finalized and only used as a means to test the web proxy.
-
-## How to build
-Running `pnpm dev` will build Scramjet and start a dev server on localhost:1337. If you only want to build the proxy without using the dev server, run `pnpm build`.
-
-
-
-## TODO
-- Finish HTML rewriting
-    - `<script type="importmap"></script>` rewriting
-        - Make an array of all possible import values and pass the array onto the JS rewriter, then rewrite all the URLs inside of it
-- Finish JS rewriting 
-    - Only thing rewritten currently are imports and exports
-    - Check imports/exports for values contained in the `importmap` array, don't rewrite the node value if present
-- Write client APIs
+<h3 align="center"><img width="80" alt="Browser.js" src="./assets/icon-256.png"></h3>
+
+<h3 align="center">Highly Configurable Browser Environment for the Web</h3>
+
+<p align="center">
+    <a href="https://puter.com/app/puter-browser-beta"><strong>« LIVE DEMO »</strong></a>
+    <br />
+    <br />
+    <a href="https://puter.com">Puter.com</a>
+    ·
+    <a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>
+    ·
+    <a href="https://reddit.com/r/puter">Reddit</a>
+    ·
+    <a href="https://twitter.com/HeyPuter">X</a>
+</p>
+<h3 align="center"><img style="border-radius:5px;" alt="screenshot" src="./assets/screenshot.png"></h3>
+
+<br>
+
+# Browser.js
+
+"A browser in a browser!", Browser.js is a highly configurable browser environment for the web.
+
+It can be used as:
+
+- An end-to-end encrypted, cloud-based browser accessible from any device at anytime
+- A headless browser that can be embedded in other websites and applications
+- A fast, lightweight, and no-installation alternative to Puppeteer, Playwright, and Selenium
+- An alternative to Ultraviolet, Rammerhead, and other web proxy browsers
+
+
+<br>
+
+## Getting Started
+
+See [CONTRIBUTING.md](/CONTRIBUTING.md) for build instructions
+
+> [!WARNING]
+> Browser.js does not currently have site isolation! Do not use it for sensitive data!
+
+<br>
+
+
+## Support
+
+Connect with the maintainers and community through these channels:
+
+- Bug report or feature request? Please [open an issue](https://github.com/HeyPuter/browser.js/issues/new/choose).
+- Discord: [discord.com/invite/PQcx7Teh8u](https://discord.com/invite/PQcx7Teh8u)
+- X (Twitter): [x.com/HeyPuter](https://x.com/HeyPuter)
+- Reddit: [reddit.com/r/puter/](https://www.reddit.com/r/puter/)
+- Mastodon: [mastodon.social/@puter](https://mastodon.social/@puter)
+- Security issues? [security@puter.com](mailto:security@puter.com)
+- Email maintainers at [hi@puter.com](mailto:hi@puter.com)
+
+We are always happy to help you with any questions you may have. Don't hesitate to ask!
+
+<br/>
+
+## License
+
+This repository, including all its contents, sub-projects, modules, and components, is licensed under [AGPL-3.0](https://github.com/HeyPuter/puter/blob/main/LICENSE.txt) unless explicitly stated otherwise. Third-party libraries included in this repository may be subject to their own licenses.
+
+<br/>