Skip to content

Commit eb7a550

Browse files
committed
Update README
1 parent 54ca3dc commit eb7a550

File tree

1 file changed

+59
-36
lines changed

1 file changed

+59
-36
lines changed

README.md

Lines changed: 59 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,47 @@
11
# CodeTweak
22

3-
**CodeTweak** is a modern user script manager and JS editor designed as a modern alternative to Tampermonkey.
3+
**CodeTweak** is a modern user script manager and JavaScript editor, designed as a modern alternative to Tampermonkey. It is fully open source and built with privacy in mind.
44

55
---
66

77
## Description
8-
CodeTweak is fully open source and provides support for manifest v3. The code editor offers features like linting, formatting, basic autocomplete, and syntax highlighting. CodeTweak supports all the safe GM APIs, and url matching. Users can also install scripts directly from Greasy Fork and manage them on the dashboard. The extension is also privacy focused and we do not track, collect or sell user data. All permissions are implemented for GM API support.
8+
9+
CodeTweak provides full support for **Manifest V3**, offering a modern code editor with linting, formatting, basic autocomplete, and syntax highlighting. It supports all safe GM APIs and URL matching. Users can install scripts directly from **Greasy Fork** and manage them via the dashboard.
10+
11+
We prioritize privacy: **no tracking, no analytics, no selling of user data**. All permissions are only requested for GM API support.
912

1013
---
1114

1215
## Features
1316

14-
- **Code Editor** — Edit scripts in a custimisable editor with built in linting, formatting, autocomplete and syntax highlighting.
15-
- **GM API support** — Supports all safe GM API's
16-
- **Regrex URLS** — Supports modern regexing for URL's
17-
- **Greasy Fork** — Install greasyfork scripts from inside CodeTweak or from the website itself.
18-
- **Privacy** — No tracking, no analytics, no unnecessary permissions.
19-
---
17+
* **Code Editor** — Customizable editor with linting, formatting, autocomplete, and syntax highlighting.
18+
* **GM API Support** — Supports all safe GM APIs.
19+
* **Regex URLs** — Modern regex support for URL matching.
20+
* **Greasy Fork Integration** — Install scripts directly from CodeTweak or the Greasy Fork website.
21+
* **Privacy First** — No tracking, no analytics, only necessary permissions.
2022

23+
---
2124

2225
## Contributing
23-
Anyone is welcome
2426

27+
We welcome contributions from the community! Whether fixing bugs, adding features, or improving documentation, your help is appreciated.
28+
29+
### Development
30+
31+
#### Prerequisites
32+
33+
* Node.js 16+
34+
* npm
35+
* Chrome/Chromium browser
36+
37+
#### Build
38+
39+
```bash
40+
npm install
41+
node build.js
42+
```
43+
44+
---
2545

2646
## TODO List
2747

@@ -31,9 +51,7 @@ Anyone is welcome
3151

3252
* [ ] `GM_download`
3353
* [ ] `GM_confirm`
34-
* [ ] (Add others as needed)
35-
36-
---
54+
* [ ] Additional APIs as needed
3755

3856
### Security & Permissions
3957

@@ -42,48 +60,53 @@ Anyone is welcome
4260
* [ ] Allow scripts to load external resources
4361
* [ ] Enable loading of third-party libraries and external scripts
4462
* [ ] Ask for confirmation when a script runs on a website for the first time
45-
* [ ] Create a centralized file for checking script access permissions on pages
46-
47-
---
63+
* [ ] Centralize script access permission checks
4864

4965
### Core Improvements
5066

5167
* [ ] Fix version checking logic
52-
* [ ] Clean and improve `ExternalScriptLoader`
53-
* [ ] Improve `getScriptDescription` function
68+
* [ ] Improve `ExternalScriptLoader`
69+
* [ ] Refine `getScriptDescription` function
5470
* [ ] Deduplicate logic between `background.js`, `inject.js`, and `GM_core.js`
5571
* [ ] Unify or reuse declarations between `GM_core` and `inject`
5672

57-
---
58-
5973
### Editor & UI
6074

61-
* [ ] Reduce editor bundle size (currently ~1.4 MB)
75+
* [ ] Reduce editor bundle size (~1.4 MB currently)
6276
* [ ] Split large editor manager files into smaller modules
63-
* [ ] Create a more sophisticated extension management system for CodeMirror
77+
* [ ] Enhance extension management for CodeMirror
6478
* [ ] Link CodeMirror minimap toggle
65-
* [ ] Move `exportScript` function to a helper file
66-
* [ ] Move `generateTamperMonkeyHeader` to a helper file
67-
* [ ] Move script import management logic to its own file
68-
* [ ] Add setting to toggle whether scripts run in main world or isolated world
69-
* [ ] Display execution world (main/isolated) in the editor
70-
* [ ] Display run-at time on dashboard
79+
* [ ] Move helper functions (`exportScript`, `generateTamperMonkeyHeader`) to separate files
80+
* [ ] Modularize script import logic
81+
* [ ] Add option to toggle execution in main world or isolated world
82+
* [ ] Display execution world and run-at time in editor/dashboard
7183
* [ ] Improve URL display formatting
72-
* [ ] Clean up and refine CSS for menu commands and import UI
84+
* [ ] Refine CSS for menu commands and import UI
85+
* [ ] Log script errors and display in editor
86+
* [ ] Add iframe preview with live refresh
7387

74-
---
7588

7689
### Debugging & Notifications
7790

78-
* [ ] Add feature to show script errors directly on the page (no console needed)
79-
* [ ] Add "Debug Mode" setting to enable the above feature
80-
* [ ] Separate "Show Script Notification" into its own file
91+
* [ ] Display script errors directly on page (without console)
92+
* [ ] Add "Debug Mode" to enable in-page error display
93+
* [ ] Separate script notification logic into its own file
94+
95+
### Communication & Helpers
96+
97+
* [ ] Simplify or centralize communication between content scripts and background scripts
98+
* [ ] Optional Trusted Types helpers
8199

82100
---
83101

84-
### Communication & Helpers
102+
## Acknowledgments
103+
104+
* Built with [CodeMirror](https://codemirror.net/)
105+
* Inspired by [Tampermonkey](https://www.tampermonkey.net/) and [Greasemonkey](https://www.greasespot.net/)
106+
* Icons from [Feather](https://feathericons.com/)
107+
108+
---
85109

86-
* [ ] Simplify or remove redundant communication between content scripts and background scripts (consider centralizing in helper file)
87-
* [ ] Provide optional Trusted Types helpers
110+
## License
88111

89-
---
112+
This project is licensed under the **MIT License**. See the [LICENSE](LICENSE.txt) file for details.

0 commit comments

Comments
 (0)