diff --git a/README.md b/README.md index f0e8e33..1cfef33 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,18 @@ Wallos Fetcher is a command-line utility designed to retrieve and export subscription data from a self-hosted [Wallos](https://github.com/WallosApp/Wallos) instanceโ€”an open-source personal subscription tracker. -This script helps you keep track of all your recurring expenses and share that information in human-readable or machine-readable formats, making it especially useful for budgeting, personal finance planning, and digital legacy preparation for family members. +This script helps you keep track of all your recurring expenses and share that information in human-readable or machine-readable formats. It's especially useful for budgeting, personal finance planning, and digital legacy preparation for family members. --- ## โœจ Features -- ๐Ÿ“„ **Markdown output by default** โ€“ easy to read, easy to share +- ๐Ÿ“„ **Markdown output by default** โ€“ clean, readable reports +- ๐Ÿ“Š **CSV output** โ€“ spreadsheet-friendly for Excel, Numbers, etc. - ๐Ÿ’พ Export as **Markdown**, **CSV**, or **JSON** - ๐Ÿ” Optionally include **full subscription details** (e.g., cycle, auto-renew, currency) - ๐Ÿ—ƒ Output to a custom file +- ๐Ÿงผ Modular, readable Bash script using secure temp file handling - ๐Ÿงฐ Lightweight, portable, and dependency-minimal (requires `curl` and `jq`) --- @@ -44,6 +46,8 @@ chmod +x wallos-fetch.sh ./wallos-fetch.sh [options] ``` +> โ„น๏ธ This script requires `curl` and `jq`. Run `./wallos-fetch.sh --help` to see all options. + ### โœ… Example Commands | Purpose | Command | @@ -90,11 +94,34 @@ Structured export for use in spreadsheets or data processing tools. - Default fields: `id,name,price,next_payment,category_name,payment_method_name` - `--full` option adds: `currency_id,cycle,auto_renew`, etc. +```csv +"id","name","price","next_payment","category_name","payment_method_name" +"1","Netflix","17.99","2025-04-21","Entertainment","Credit Card" +"2","Spotify","9.99","2025-05-01","Music","PayPal" +``` + ### ๐Ÿ“ฆ JSON -Raw response data from the Wallos APIโ€”useful for backups or integrations. +Raw response data from the Wallos APIโ€”useful for backups, custom reporting, or integrations. + +```json +{ + "subscriptions": [ + { + "id": 1, + "name": "Netflix", + "price": 17.99, + "currency_id": "USD", + "next_payment": "2025-04-21", + "category_name": "Entertainment", + "payment_method_name": "Credit Card" + } + ] +} +``` --- + ## ๐Ÿ” Authentication You can set your API key in one of two ways: @@ -125,6 +152,8 @@ API_KEY="your_api_key_here" > โš ๏ธ Be cautious: hardcoding secrets in scripts can pose a security risk if the file is shared or version-controlled. +--- + ## ๐Ÿ“œ License This project is licensed under the [GNU General Public License v3.0 or later](https://www.gnu.org/licenses/gpl-3.0.html). @@ -134,7 +163,7 @@ This project is licensed under the [GNU General Public License v3.0 or later](ht ## ๐Ÿค Contributions Feedback, bug reports, and pull requests are welcome! -Submit issues or improvements via your Gitea repository. +Submit issues or improvements via the Gitea repository. --- @@ -142,4 +171,4 @@ Submit issues or improvements via your Gitea repository. Wallos is an open-source personal subscription manager. Learn more or contribute to the main project here: -๐Ÿ”— https://github.com/WallosApp/Wallos \ No newline at end of file +๐Ÿ”— https://github.com/WallosApp/Wallos