search

LDflex / Query-Solid

Simple access to data in Solid pods through LDflex expressions
https://solid.github.io/query-ldflex/
MIT License
66 stars 15 forks source link

Documentation needs updating #49

Open james-martin-jd opened 4 years ago

james-martin-jd commented 4 years ago

Didn't see an issue for this yet, so though I'd open one to track it. The documentation and README is currently very out of date, and doesn't cover some basic use cases. Notably missing is .set, .add, and .delete, as well as .from.

I think the rest of the docs should also be reviewed for accuracy and much has changed since it was written. Some kind of small tutorial / example code would also be very nice.

linonetwo commented 4 years ago

So it can add files or folders now? Where can I learn how? From the test? The test is a bit abstract.

Vinnl commented 4 years ago

@linonetwo I don't think LDFlex can specifically add empty files or folders yet, but examples of some common operations can be found here, in lieu of official documentation: https://vincenttunru.gitlab.io/tripledoc/docs/cheatsheet

james-martin-jd commented 4 years ago

@linonetwo to my knowledge, no, it can't add files/folders, but it can delete. I believe .add() creates a new literal or node, and .set adds OR updates a literal or node value. But this kind of confusion is exactly why I think additional documentation is needed, as the current readme is very out of date.

I typically just use a fetch to create a file or folder, according to the Solid Spec.