update documentation

Author: charkour

.vscode/csp.code-workspace .vscode/csps.code-workspace.vscode/csp.code-workspace renamed to .vscode/csps.code-workspace

@@ -2,12 +2,12 @@
 
 Tools to solve [constraint satisfaction problems](https://en.wikipedia.org/wiki/Constraint_satisfaction_problem): **C**onstraint **S**atisfaction **P**roblem **S**olvers.
 
-<a href="https://www.npmjs.com/package/csps"><img src="https://img.shields.io/npm/v/csps.svg" alt="npm version"></a>
-<a href="" disabled><img src="https://img.shields.io/badge/node-%3E%3D10-blue.svg?cacheSeconds=2592000" alt="node >= 10"></a>
-<a href="https://www.npmjs.com/package/csps"><img src="https://img.shields.io/bundlephobia/minzip/csps.svg" alt="size < 1k"></a>
-<a href="https://github.com/charkour/csps"><img src="https://img.shields.io/github/workflow/status/charkour/csps/CI.svg" alt="build status"></a>
-<a href="https://www.npmjs.com/package/csps"><img src="https://img.shields.io/david/charkour/csps" alt="zero deps"></a>
-[![Downloads](https://img.shields.io/npm/dt/csps.svg)](https://www.npmjs.com/package/csps)
+[![npm version](https://img.shields.io/npm/v/csps.svg)](https://www.npmjs.com/package/csps)
+![node >= 10](https://img.shields.io/badge/node-%3E%3D10-blue.svg?cacheSeconds=2592000)
+[![size < 1k](https://img.shields.io/bundlephobia/minzip/csps.svg)](https://www.npmjs.com/package/csps)
+[![build status](https://img.shields.io/github/workflow/status/charkour/csps/CI.svg)](https://github.com/charkour/csps)
+[![zero deps](https://img.shields.io/david/charkour/csps)](https://www.npmjs.com/package/csps)
+[![downloads](https://img.shields.io/npm/dt/csps.svg)](https://www.npmjs.com/package/csps)
 
 > Inspired by [Russell and Norvig's "Artificial Intelligence - A Modern Approach" Python code](https://github.com/aimacode/aima-python) and modified under the MIT license.
 
@@ -30,21 +30,26 @@ index.ts:
 ```ts
 import { CSP, min_conflicts } from "csps";
 
+// define the attributes on your variable
+interface VariableAttributes {
+  // {[key: string]: string}
+}
+
 // Setup your problem
 const variables = [
   /* array of strings */
 ];
 const domains = {
-  /* var: possible_attributes<string>[] */
+  /* var: possible_attributes (type: VariableAttributes[]) */
 };
 const neighbors = {
-  /* var: neighbors<string>[] */
+  /* var: neighbors (type: <string>[]) */
 };
 const constraints = (
   var1: string,
-  var1Attributes: string[],
+  var1Attributes: VariableAttributes[],
   var2: string,
-  var2Attributes: string[],
+  var2Attributes: VariableAttributes[],
 ): boolean => {
   // Return true if same variable.
   if (var1 === var2) {
@@ -57,11 +62,16 @@ const constraints = (
   return true;
 };
 
-const aCSP = new CSP<string>(variables, domains, neighbors, constraints);
+const aCSP = new CSP<VariableAttributes>(variables, domains, neighbors, constraints);
 
 // run min_conflicts on problem
 const res = min_conflicts(aCSP);
 console.log(res);
+// {
+//   var1: { attr1: 'value1', attr2: 'value1', attr3: 'value1' },
+//   var2: { attr1: 'value2', attr2: 'value2', attr3: 'value2' },
+//   var3: { attr1: 'value3', attr2: 'value3', attr3: 'value3' },
+// } // or something similar.
 ```
 
 ### Demo

README.md

@@ -51,7 +51,7 @@ export const constraints = (
 ): boolean => {
   /*
     Constraints for class scheduling
-    c1 and c2 are tuples in the form (time, room, faculty)
+    c1 and c2 are objects in the form {time, room, faculty}
     returns true if constraints are met.
     The constraint that there is only one section of class
     is implicit because classes are variables.