tasks module readme

Author: michielbdejong

tasks/README.md

@@ -1,3 +1,43 @@
 ## Tasks Data Module
 
-(under construction)
+To use this Solid Data Module you need an authenticated fetch function. In Node.JS, when working against a CSS or Pivot server such as solidcommnunity.net, you can use [css-authn](https://www.npmjs.com/package/css-authn#usage) for this. In the browser, you can use [Inrupt Solid Client](https://docs.inrupt.com/developer-tools/javascript/client-libraries/authentication/).
+
+
+### Usage
+Set up a typescript project, install [solid-data-module-tasks](https://www.npmjs.com/package/solid-data-module-tasks) from NPM, and create a `.env` file like this:
+```env
+SOLID_SERVER=https://solidcommunity.net
+SOLID_EMAIL=michielbdejong@users.css.pod
+SOLID_PASSWORD=...
+```
+
+Make sure there is a Solid OS issue tracker at `trackerUrl`. You can create this through the web interface of Pivot.
+
+Then save, build and run the following TypeScript file:
+```ts
+import 'dotenv/config';
+import { v7 } from 'css-authn';
+import { fetchTracker, Interpretation, addIssue, addComment } from 'solid-data-module-tasks';
+
+const authenticatedFetch = await v7.getAuthenticatedFetch({
+  email: process.env.SOLID_EMAIL,
+  password: process.env.SOLID_PASSWORD,
+  provider: process.env.SOLID_SERVER,
+});
+const trackerUrl = 'https://michielbdejong.solidcommunity.net/tasks/index.ttl#this';
+const localState: Interpretation = await fetchTracker(trackerUrl, authenticatedFetch);
+const issueUri = await addIssue(localState, {
+    title: 'Use the Solid Data Module for Tasks',
+    description: 'Solid app devs should not be rolling their own task tracker access code.',
+}, authenticatedFetch);
+const newComment = {
+  issueUri,
+  author: 'https://michielbdejong.solidcommunity.net/profile/card#me',
+  text: `I totally agree at ${new Date().toUTCString()}`,
+};
+const commentUri = await addComment(localState, newComment, authenticatedFetch);
+console.log(commentUri);
+```
+
+This will result in an issue and a comment being created in that tracker:
+![screenshot](https://github.com/user-attachments/assets/8d0a1aef-94c8-4c41-848d-d21edfe5f116)