Skip to content

Commit

Permalink
Update repo readme (#126)
Browse files Browse the repository at this point in the history
  • Loading branch information
cmonfortep authored Dec 12, 2024
1 parent 8add0a2 commit 439f1e2
Showing 1 changed file with 25 additions and 1 deletion.
26 changes: 25 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,28 @@
# DuckDuckGo Remote Messaging Configuration
===========================================

This is a Work in Progress repository.
## What is it?
This is the configuration repository for the Remote Messaging Framework (RMF). This repository hosts the configuration files that enable the RMF system, remotely controlling messages received and processed by native app clients.

[Remote Messaging Framework Asana board](https://app.asana.com/0/1207619243206445/1207619413684520)

## Folder Structure
Remote Messaging Config is organized as follows:

- /live/: Hosts the configurations for each client.
- /samples/: Contains example configurations.
- /templates/: Provides template files for creating new configurations.

# Remote Config URLs
- Native apps using the Remote Messaging Configuration:
- [iOS app](https://github.com/duckduckgo/iOS)
- Live: [ios-config.json](https://staticcdn.duckduckgo.com/remotemessaging/config/v1/ios-config.json)
- [Android app](https://github.com/duckduckgo/Android)
- Live: [android-config.json](https://staticcdn.duckduckgo.com/remotemessaging/config/v1/android-config.json)
- [Mac app](https://github.com/duckduckgo/macos-browser):
- Live: [macos-config.json](https://staticcdn.duckduckgo.com/remotemessaging/config/v1/macos-config.json)
- Windows app (in beta, code not yet open source)
- Live: [windows-config.json](https://staticcdn.duckduckgo.com/remotemessaging/config/v1/windows-config.json)

## License
DuckDuckGo is distributed under the Apache 2.0 [license](https://github.com/duckduckgo/BrowserServicesKit/blob/main/LICENSE).

0 comments on commit 439f1e2

Please sign in to comment.