Merge pull request #15 from DysphoricUnicorn/add-usage-example-to-readme

Add usage example to README
Modyfi · Apr 12, 2023 · d21e828 · d21e828
2 parents 64ef20c + 97bbb88
commit d21e828
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -29,6 +29,16 @@ export default {
 };
 ```
 
+Then you can simply import yaml files like you would any other file:
+
+```ts
+import YamlContent from './your.yaml';
+
+console.log(YamlContent.example);
+```
+
+Do note that you may have to include the file type in your import.
+
 ### 🔦 TypeScript support
 
 The recommended way to add type definitions for `.yaml` or `.yml` modules is via a `tsconfig.json` file.