From b60c0b29f883dfebaab70adf24bb4925f9c23f84 Mon Sep 17 00:00:00 2001 From: MaysWind Date: Wed, 2 Jul 2025 23:45:28 +0800 Subject: [PATCH] update README.md --- README.md | 114 +++++++++++++++++++++++++++++++++++------------------- 1 file changed, 75 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index cd78df68..3b95816f 100644 --- a/README.md +++ b/README.md @@ -6,39 +6,43 @@ [![Latest Release](https://img.shields.io/github/release/mayswind/ezbookkeeping.svg?style=flat)](https://github.com/mayswind/ezbookkeeping/releases) ## Introduction -ezBookkeeping is a lightweight, self-hosted personal finance app with a user-friendly interface and powerful bookkeeping features. It supports PWA, you can [add the app homepage to the home screen](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/add_to_home_screen.gif) of your mobile device and use it just like a native app. It's easily to be deployed and configured, you can just deploy it by a single command via Docker. It supports almost all platforms, including Windows, macOS, and Linux, and is compatible with x86, amd64 and ARM hardware architectures. It only requires very few system resources, and you can even run it on a Raspberry Pi device. +ezBookkeeping is a lightweight, self-hosted personal finance app with a sleek, user-friendly interface and powerful bookkeeping features. Built with simplicity and portability in mind, it's easy to deploy, easy to use, and requires minimal system resources — perfect for microservers, NAS devices, and even Raspberry Pi. -Online Demo: [https://ezbookkeeping-demo.mayswind.net](https://ezbookkeeping-demo.mayswind.net) +The app is fully cross-platform and device-friendly — you can use it seamlessly on **mobile, tablet, and desktop devices**. With support for PWA (Progressive Web Apps), you can even [add it to your mobile home screen](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/add_to_home_screen.gif) and use it like a native app. + +Live Demo: [https://ezbookkeeping-demo.mayswind.net](https://ezbookkeeping-demo.mayswind.net) ## Features -1. Open Source & Self-Hosted -2. Lightweight & Fast -3. Easy Installation - * Support Docker - * Support multiple databases (SQLite, MySQL, PostgreSQL, etc.) - * Support multiple operation system & hardware architectures (Windows, macOS, Linux & x86, amd64, ARM) -4. User-Friendly Interface - * Native UI for both desktop and mobile devices - * Support PWA, providing near-native experience for mobile devices - * Dark theme -5. Powerful Bookkeeping Features - * Support two-level account - * Support two-level transaction categories and predefined categories - * Support transaction pictures - * Support geographic location tracking and map - * Support recurring transactions - * Search and filter transaction records - * Data visualization and statistical analysis -6. Localization Support - * Multi-language support - * Multi-currency support with automatic exchange rate updates from various financial institutions - * Multi-timezone support - * Customizable date, time, number and currency display formats -7. Security & Reliability - * Two-factor authentication (2FA) - * Login rate limiting - * Application lock (PIN code / WebAuthn) -8. Data Export & Import (CSV, OFX, QFX, QIF, IIF, Camt.053, MT940, GnuCash, FireFly III, Beancount, etc.) +- **Open Source & Self-Hosted** + - Built for privacy and control +- **Lightweight & Fast** + - Optimized for performance, runs smoothly even on low-resource environments +- **Easy Installation** + - Docker-ready + - Supports SQLite, MySQL, PostgreSQL + - Cross-platform (Windows, macOS, Linux) + - Works on x86, amd64, ARM architectures +- **User-Friendly Interface** + - UI optimized for both mobile and desktop + - PWA support for native-like mobile experience + - Dark mode +- **Powerful Bookkeeping** + - Two-level accounts and categories + - Attach images to transactions + - Location tracking with maps + - Recurring transactions + - Advanced filtering, search, visualization, and analysis +- **Localization & Globalization** + - Multi-language and multi-currency support + - Automatic exchange rates + - Multi-timezone awareness + - Custom formats for dates, numbers, and currencies +- **Security** + - Two-factor authentication (2FA) + - Login rate limiting + - Application lock (PIN code / WebAuthn) +- **Data Import/Export** + - Supports CSV, OFX, QFX, QIF, IIF, Camt.053, MT940, GnuCash, Firefly III, Beancount, and more ## Screenshots ### Desktop Version @@ -48,19 +52,19 @@ Online Demo: [https://ezbookkeeping-demo.mayswind.net](https://ezbookkeeping-dem [![ezBookkeeping](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/en.png)](https://raw.githubusercontent.com/wiki/mayswind/ezbookkeeping/img/mobile/en.png) ## Installation -### Ship with docker +### Run with Docker Visit [Docker Hub](https://hub.docker.com/r/mayswind/ezbookkeeping) to see all images and tags. -Latest Release: +**Latest Release:** $ docker run -p8080:8080 mayswind/ezbookkeeping -Latest Daily Build: +**Latest Daily Build:** $ docker run -p8080:8080 mayswind/ezbookkeeping:latest-snapshot -### Install from binary -Latest release: [https://github.com/mayswind/ezbookkeeping/releases](https://github.com/mayswind/ezbookkeeping/releases) +### Install from Binary +Download the latest release: [https://github.com/mayswind/ezbookkeeping/releases](https://github.com/mayswind/ezbookkeeping/releases) **Linux / macOS** @@ -70,9 +74,9 @@ Latest release: [https://github.com/mayswind/ezbookkeeping/releases](https://git > .\ezbookkeeping.exe server run -ezBookkeeping will listen at port 8080 as default. Then you can visit `http://{YOUR_HOST_ADDRESS}:8080/` . +By default, ezBookkeeping listens on port 8080. You can then visit `http://{YOUR_HOST_ADDRESS}:8080/` . -### Build from source +### Build from Source Make sure you have [Golang](https://golang.org/), [GCC](http://gcc.gnu.org/), [Node.js](https://nodejs.org/) and [NPM](https://www.npmjs.com/) installed. Then download the source code, and follow these steps: **Linux / macOS** @@ -87,13 +91,45 @@ All the files will be packaged in `ezbookkeeping.tar.gz`. All the files will be packaged in `ezbookkeeping.zip`. -You can also build docker image, make sure you have [docker](https://www.docker.com/) installed, then follow these steps: +You can also build a Docker image. Make sure you have [Docker](https://www.docker.com/) installed, then follow these steps: **Linux** $ ./build.sh docker -## Documents +## Contributing +We welcome contributions of all kinds! + +Found a bug? [Submit an issue](https://github.com/mayswind/ezbookkeeping/issues) + +Want to contribute code? Feel free to fork and send a pull request. + +Contributions of all kinds — bug reports, feature suggestions, documentation improvements, or code — are highly appreciated. + +Check out our [Contributor Graph](https://github.com/mayswind/ezbookkeeping/graphs/contributors) to see the amazing people who’ve already helped. + +## Translating +Help make ezBookkeeping accessible to users around the world! If you want to contribute a translation, please refer to our [translation guide](https://ezbookkeeping.mayswind.net/translating). + +Currently available translations: + +| Tag | Language | Translator | +| --- | --- | --- | +| de | Deutsch | [@chrgm](https://github.com/chrgm) | +| en | English | / | +| es | Español | [@Miguelonlonlon](https://github.com/Miguelonlonlon) | +| it | Italiano | [@waron97](https://github.com/waron97) | +| ja | 日本語 | [@tkymmm](https://github.com/tkymmm) | +| pt-BR | Português (Brasil) | [@thecodergus](https://github.com/thecodergus) | +| ru | Русский | [@artegoser](https://github.com/artegoser) | +| uk | Українська | [@nktlitvinenko](https://github.com/nktlitvinenko) | +| vi | Tiếng Việt | [@f97](https://github.com/f97) | +| zh_Hans | 中文 (简体) | / | +| zh_Hant | 中文 (繁體) | / | + +Don't see your language? Help us add it! + +## Documentation 1. [English](http://ezbookkeeping.mayswind.net) 1. [中文 (简体)](http://ezbookkeeping.mayswind.net/zh_Hans)