search

typicode / lowdb

Simple and fast JSON database
MIT License
21.35k stars 918 forks source link

Update Readme about Typescript support #541

Closed stefnotch closed 1 year ago

stefnotch commented 2 years ago

So I was searching for a simple enough "database" to use in an Electron app. I did find this repository, but after reading the first line in the Readme, I wasn't quite as confident anymore.

Simple to use local JSON database. Powered by plain JavaScript 🦉

"plain JavaScript" implies to me that this library doesn't support Typescript. The fact that Github incorrectly identified the languages of this repository sadly only helped that mistaken impression. image

I'd love it if the Readme advertised the Typescript support a tiny bit more.

typicode commented 1 year ago

Updated ;) thank you for the feedback, I hope it's clearer this way. As for the language, it's on purpose and for discoverability, most people search for JavaScript project. Unfortunately, GitHub doesn't include TypeScript repos in JavaScript results.