chore: improve README.md

unjs / rc9

Read/Write config couldn't be easier!

Other

269 stars 5 forks source link

🔗 Linked issue

Resolves #107

❓ Type of change

[x] 📖 Documentation (updates to the documentation, readme, or JSdoc annotations)
[ ] 🐞 Bug fix (a non-breaking change that fixes an issue)
[ ] 👌 Enhancement (improving an existing functionality like performance)
[ ] ✨ New feature (a non-breaking change that adds functionality)
[ ] 🧹 Chore (updates to the build process or auxiliary tools and libraries)
[ ] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)

📚 Description

I just updated README based on the feedback in #107:

Modify the example .conf so that it shows cases of single word, multi words, and boolean
Change second argument of update method example for it to be consistent with other examples

📝 Checklist

[x] I have linked an issue or discussion.
[x] I have updated the documentation accordingly.

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 100.00%. Comparing base (db73008) to head (f4585e4). Report is 10 commits behind head on main.

:exclamation: Current head f4585e4 differs from pull request most recent head 8fc460c. Consider uploading reports for the commit 8fc460c to get more accurate results

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #113 +/- ## ========================================= Coverage 100.00% 100.00% ========================================= Files 1 1 Lines 139 139 Branches 29 29 ========================================= Hits 139 139 ```

unjs / rc9