From 0ed4b572c0bb69e7a32bc4bd7a8f3eb211b225bb Mon Sep 17 00:00:00 2001 From: Robert Sesek Date: Mon, 23 Mar 2020 18:39:13 -0400 Subject: [PATCH] Update the README with working instructions. --- README.md | 10 ++++++---- doc/changes.md | 10 ++++++++++ 2 files changed, 16 insertions(+), 4 deletions(-) create mode 100644 doc/changes.md diff --git a/README.md b/README.md index 6940232..d71c8ea 100644 --- 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 index 0000000..2ce883a --- /dev/null +++ b/doc/changes.md @@ -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. -- 2.22.5