diff --git a/README.md b/README.md index 70f268f..f220f06 100644 --- a/README.md +++ b/README.md @@ -1 +1,35 @@ -# hiddify-next-core \ No newline at end of file +# hiddify-next-core + + +## Extension + +An extension is something that can be added to hiddify application by a third party. It will add capability to modify configs, do some extra action, show and receive data from users. + +This extension will be shown in all Hiddify Platforms such as Android/macOS/Linux/Windows/iOS + +[Create an extension](https://github.com/hiddify/hiddify-app-example-extension) + +Features and Road map: + +- [x] Add Third Party Extension capability +- [x] Test Extension from Browser without any dependency to android/mac/.... `./cmd.sh extension` the open browser `https://127.0.0.1:12346` +- [x] Show Custom UI from Extension `github.com/hiddify/hiddify-core/extension.UpdateUI()` +- [x] Show Custom Dialog from Extension `github.com/hiddify/hiddify-core/extension.ShowDialog()` +- [x] Show Alert Dialog from Extension `github.com/hiddify/hiddify-core/extension.ShowMessage()` +- [x] Get Data from UI `github.com/hiddify/hiddify-core/extension.SubmitData()` +- [x] Save Extension Data from `e.Base.Data` +- [x] Load Extension Data to `e.Base.Data` +- [x] Disable / Enable Extension +- [x] Update user proxies before connecting `github.com/hiddify/hiddify-core/extension.BeforeAppConnect()` +- [x] Run Tiny Independent Instance `github.com/hiddify/hiddify-core/extension/sdk.RunInstance()` +- [x] Parse Any type of configs/url `github.com/hiddify/hiddify-core/extension/sdk.ParseConfig()` +- [ ] ToDo: Add Support for MultiLanguage Interface +- [ ] ToDo: Custom Extension Outbound +- [ ] ToDo: Custom Extension Inbound +- [ ] ToDo: Custom Extension ProxyConfig + + Demo Screenshots from HTML: + + image + image +