Update the README with working instructions.
authorRobert Sesek <rsesek@bluestatic.org>
Mon, 23 Mar 2020 22:39:13 +0000 (18:39 -0400)
committerRobert Sesek <rsesek@bluestatic.org>
Mon, 23 Mar 2020 23:18:10 +0000 (19:18 -0400)
README.md
doc/changes.md [new file with mode: 0644]

index 694023285f01427e5ac779c89825a55bc1a56224..d71c8ea3d77ceeb92ef1d72c13d959362ad443df 100644 (file)
--- a/README.md
+++ b/README.md
@@ -42,11 +42,11 @@ To start using the software, create a new, private NPM project, and install the
 dependencies. This will also install the HTML viewer. Then copy an example file and run the viewer
 with it.
 
-    npm init
-    # answer questions
+    mkdir taxes && cd taxes
+    echo '{"private":true}' > package.json
     npm i ts-node typescript ustaxlib ustaxviewer
     cp node_modules/ustaxlib/examples/fed2019.ts .
-    npx ustaxviewer-ts fed2019.ts
+    npx ustaxviewer fed2019.ts
 
 ## Contributing
 
@@ -66,7 +66,9 @@ liability throughout the year, or to learn about the US tax system.
 ### Should I use this to file my own tax returns?
 
 Please, heck no. There are guaranteed to be bugs in this software. The models do not support every
-and situation. This software is provided with no warranty.
+situation, and many more complex parts of forms are not implemented. This software is provided with
+no warranty. There is no wizard/interview system; it is expected that you use the instructions on
+[the IRS website](https://www.irs.gov) to set up and input data into the forms.
 
 ### How well does it work?
 
diff --git a/doc/changes.md b/doc/changes.md
new file mode 100644 (file)
index 0000000..2ce883a
--- /dev/null
@@ -0,0 +1,10 @@
+# ustaxlib Change Log
+
+## 1.0.2
+- Only publish the dist/ folder.
+
+## 1.0.1
+- Include examples in the NPM package.
+
+## 1.0.0
+Initial release.