update README

Author: y1j2x34

README.md

@@ -1,39 +1,45 @@
-# Propify 
+# 🔧 Propify
 
 ![Build Status](https://github.com/vgerbot-libraries/propify/actions/workflows/build.yml/badge.svg) [![Codacy Badge](https://app.codacy.com/project/badge/Grade/9d3df77c87d243a9bb68b8687a87bfeb)](https://app.codacy.com/gh/vgerbot-libraries/propify/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) [![Codacy Badge](https://app.codacy.com/project/badge/Coverage/9d3df77c87d243a9bb68b8687a87bfeb)](https://app.codacy.com/gh/vgerbot-libraries/propify/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage)
 
 ----
 
-A lightweight Java annotation processor that automatically generates **type-safe** classes for both configuration files (YAML or `.properties`) and internationalization bundles. Access every configuration key and message through Java methods—no more stringly-typed keys—and catch invalid accesses at compile time. Supports nested properties, custom lookup providers, and full ICU4J formatting.
+**Propify** is a powerful, lightweight Java annotation processor that eliminates configuration errors by generating **type-safe** classes from your configuration files (YAML, INI, or `.properties`) and internationalization bundles.
 
----
+> **Say goodbye to "stringly-typed" keys and runtime errors!** Access every configuration value and message through strongly-typed Java methods, catching invalid accesses at compile time instead of runtime.
+
+Propify seamlessly supports nested properties, custom lookup providers, and full ICU4J formatting while adding zero runtime dependencies to your application.
+
+----
 
 ## 📖 Table of Contents
 
-1. [Why Propify?](#why-propify)
-2. [Features](#features)
-3. [Requirements](#requirements)
-4. [Installation](#installation)
-5. [Quick Start](#quick-start)
-6. [Advanced Usage](#advanced-usage)
-7. [Internationalization (i18n)](#internationalization-i18n)
-8. [How It Works](#how-it-works)
-9. [Contributing](#contributing)
-10. [License](#license)
-11. [Acknowledgments](#acknowledgments)
+1. [Why Propify?](#-why-propify)
+2. [Features](#-features)
+3. [Requirements](#-requirements)
+4. [Installation](#-installation)
+5. [Quick Start](#-quick-start)
+6. [Advanced Usage](#-advanced-usage)
+7. [Internationalization (i18n)](#-internationalization-i18n)
+8. [How It Works](#️-how-it-works)
+9. [Examples](#-examples)
+10. [Getting Help](#-getting-help)
+11. [Contributing](#-contributing)
+12. [License](#-license)
+13. [Acknowledgments](#-acknowledgments)
 
----
+----
 
-## Why Propify?
+## 🤔 Why Propify?
 
 - **Type-Safety**: Access configuration and messages via Java methods—no more stringly-typed keys.
 - **Compile-Time Guarantees**: Prevent typos in code (incorrect keys) from compiling, so invalid property accesses are caught before runtime.
 - **Productivity**: Skip manual parsing and error-prone lookups.
 - **Extendable**: Plug in custom lookup providers for environment variables, system properties, or your own sources.
 
----
+----
 
-## Features
+## ✨ Features
 
 - 🔒 **Type-Safe Config**: Generates POJOs from YAML, INI, or `.properties` files
 - 🌐 **Type-Safe i18n**: Strongly-typed resource bundles with ICU4J formatting
@@ -42,16 +48,16 @@ A lightweight Java annotation processor that automatically generates **type-safe
 - 🔄 **Custom Lookups**: Inject dynamic values (env, system props, custom)
 - ⚡️ **Zero Runtime Overhead**: All code generated at compile time
 
----
+----
 
-## Requirements
+## 📋 Requirements
 
 - **Java**: 8 or higher
 - **Build**: Maven or Gradle
 
----
+----
 
-## Installation
+## 📥 Installation
 
 ### Maven
 
@@ -111,11 +117,12 @@ dependencies {
 
 > For other tools, configure your build to include `propify` as an annotation processor.
 
----
+----
 
-## Quick Start
+## 🚀 Quick Start
 
 1. **Create** `src/main/resources/application.yml`:
+
    ```yaml
    server:
      host: localhost
@@ -125,12 +132,16 @@ dependencies {
      username: root
      password: secret
    ```
+
 2. **Annotate** an interface:
+
    ```java
    @Propify(location = "application.yml")
    public interface AppConfig {}
    ```
+
 3. **Use** the generated API:
+
    ```java
    public class Main {
      public static void main(String[] args) {
@@ -142,6 +153,7 @@ dependencies {
    ```
 
 Configuration locations can be:
+
 - On the classpath (e.g., `application.yml` in `src/main/resources/`)
 - Local file system (`file:///path/to/config.yml`)
 - HTTP/HTTPS URL (`https://...`)
@@ -155,9 +167,9 @@ public interface WebConfig {}
 
 > ⚠️ Ensure your configuration files are reachable at build time—whether via classpath, file path, or network URL.
 
----
+----
 
-## Advanced Usage
+## 🔧 Advanced Usage
 
 ### Custom Class Name
 
@@ -189,13 +201,15 @@ Propify lets you interpolate dynamic values at build time via lookup providers.
 - **Custom lookups**: `{lookupName:variableName}` — resolved by the corresponding lookup class
 
 **Example configuration** (`application.yml`):
+
 ```yaml
 app:
   tempDir: "{env:TEMP_DIR}"
   secretKey: "{vault:db-secret}"
 ```
 
 **Annotate your interface**:
+
 ```java
 @Propify(
   location = "application.yml",
@@ -208,20 +222,21 @@ public interface AppConfig {}
 ```
 
 **Usage in code**:
+
 ```java
 AppConfig cfg = new AppConfigPropify();
 String tempDir = cfg.getApp().getTempDir();    // from $TEMP_DIR
 String secret = cfg.getApp().getSecretKey();   // from vault lookup
-```  
-
----  
+```
 
+----
 
-## Internationalization (i18n)
+## 🌐 Internationalization (i18n)
 
 Generate type-safe resource bundles using ICU4J:
 
 1. **Create** message files in `resources/`:
+
    ```properties
    # messages.properties (default)
    welcome=Welcome
@@ -231,31 +246,86 @@ Generate type-safe resource bundles using ICU4J:
    welcome=欢迎
    greeting=你好, {name}！
    ```
+
 2. **Annotate** a class:
+
    ```java
    @I18n(baseName = "messages", defaultLocale = "en")
    public class Messages {}
    ```
+
 3. **Access** messages:
+
    ```java
    String hi = MessageResource.getDefault().greeting("Alice");
    String hiZh = MessageResource.get(Locale.CHINESE).greeting("张三");
    ```
 
 Supports pluralization, dates, numbers, and custom ICU patterns—fully validated at compile time.
 
----
+----
 
-## How It Works
+## ⚙️ How It Works
 
 1. **Scan** for `@Propify` and `@I18n` annotations
 2. **Parse** configuration and message files
 3. **Generate** Java implementation classes
 4. **Compile** everything together—fail-fast on errors
 
----
+----
+
+## 📝 Examples
+
+Here are some practical examples of how to use Propify in common scenarios:
+
+### Nested Configuration
+
+```java
+// application.yml
+// server:
+//   http:
+//     port: 8080
+//   https:
+//     port: 8443
+//     keystore: /path/to/keystore
+
+@Propify(location = "application.yml")
+public interface ServerConfig {}
+
+// Usage
+ServerConfigPropify config = new ServerConfigPropify();
+int httpPort = config.getServer().getHttp().getPort();  // 8080
+String keystore = config.getServer().getHttps().getKeystore();  // /path/to/keystore
+```
+
+### Environment-Specific Configuration
+
+```java
+// Using environment variables in your config
+// app.yml
+// database:
+//   url: "jdbc:mysql://{env:DB_HOST}:{env:DB_PORT}/{env:DB_NAME}"
+
+@Propify(
+  location = "app.yml",
+  lookups = { EnvironmentLookup.class }
+)
+public interface AppConfig {}
+```
+
+----
+
+## 🙋 Getting Help
+
+If you encounter any issues or have questions about using Propify:
 
-## Contributing
+- **GitHub Issues**: Submit a [new issue](https://github.com/vgerbot-libraries/propify/issues) on our GitHub repository
+- **Documentation**: Check the [Wiki](https://github.com/vgerbot-libraries/propify/wiki) for detailed documentation
+- **Examples**: Browse the [examples directory](https://github.com/vgerbot-libraries/propify/tree/main/examples) for sample projects
+
+----
+
+## 👥 Contributing
 
 1. Fork the repo
 2. Create a feature branch (`git checkout -b feature/xyz`)
@@ -264,18 +334,17 @@ Supports pluralization, dates, numbers, and custom ICU patterns—fully validate
 
 Please follow the existing coding style and update tests.
 
----
+----
 
-## License
+## 📄 License
 
 [MIT](LICENSE) © 2024 vgerbot-libraries
 
----
-
-## Acknowledgments
+----
 
-- [JavaPoet](https://github.com/square/javapoet)
-- [Jackson YAML](https://github.com/FasterXML/jackson-dataformats-text)
-- [Apache Commons Configuration](https://commons.apache.org/proper/commons-configuration/)
-- [ICU4J](https://unicode-org.github.io/icu/userguide/icu4j/)
+## 🙏 Acknowledgments
 
+- [JavaPoet](https://github.com/square/javapoet) - Java source file generation
+- [Jackson YAML](https://github.com/FasterXML/jackson-dataformats-text) - YAML parsing
+- [Apache Commons Configuration](https://commons.apache.org/proper/commons-configuration/) - Configuration management
+- [ICU4J](https://unicode-org.github.io/icu/userguide/icu4j/) - Internationalization support