diff --git a/README.md b/README.md index 8130a95..2aefdc5 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,17 @@ More formats are available (see [Formats](#formats)). For more details and examples, see the [examples](examples) directory. ## Formats +The following file formats are currently supported: + +| Format | Extension | Import* | Loader | Parser | Factory | +|-------------|-------------|--------------------|---------------------------|---------------------------------|-------------------------| +| _any below_ | _any below_ | `mirage` | `loadConfig`** | _(N/A)_ | | +| JSON | .json | `mirage.json` | `loadJsonConfig` | `parseJsonConfig`*** | `JsonConfigFactory` | +| Java | .properties | `mirage.java` | `loadJavaProperties` | `parseJavaProperties` | `JavaPropertiesFactory` | + +\* _Any loader or parser can be imported from the `mirage` package since they are all publicly imported._ +\*\* _Loads files based on their extension. If the file does not use one of the extensions in the table, you must use a specific loader._ +\*\*\* _Besides parsing strings like the other formats, it also accepts a `JSONValue`._ ## History