Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify implementation assumptions in the docs #90

Open
davestewart opened this issue Dec 11, 2023 · 0 comments
Open

Clarify implementation assumptions in the docs #90

davestewart opened this issue Dec 11, 2023 · 0 comments

Comments

@davestewart
Copy link

davestewart commented Dec 11, 2023

It took me longer than I would have liked to get up and running with this lib:

  • I wasn't sure where the files were saved
  • I didn't understand how the data was serialised

Quite a lot of console.loging, searching through finder folders, etc

It would be nice the following were mentioned:

  • './scratch/' is a process-relative folder (maybe just include the trailing slash?)
  • data will be saved in individual named text files, one per key, i.e. ./scratch/value
  • data should be processed using JSON.stringify / parse (the word "serialized" implies this might be done for you)

I know the docs mention "Fully implements the localStorage specfication" but it's not like I go to bed at night reading the specs.

Also:

  • typo in "specfication" (missing i after the c)

Otherwise, thanks very much! Nice lib once up and running :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant