update readme

Author: Charlie Palm

MyFirstFormula.ts

@@ -6,7 +6,7 @@ class MyFirstFormula extends NotionFormulaGenerator {
 
     // fill in your formula function here:
     formula() {
-        if (this.myProperty.value) {
+        if (this.myProperty) {
             return 1;
         }
         return 0;

README.md

@@ -5,7 +5,7 @@
 
 (updated to support Notion's new formula API!)
 
-F.R.A.N.C.I.S. (Formula Readability And Notion Compilation Improvement Stack) is a somewhat complicated but powerful and programmer friendly way of getting around the difficulty of writing large formulas in Notion. 
+F.R.A.N.C.I.S. (Formula Readability And Notion Compilation Improvement Stack) is a somewhat complicated but powerful and programmer friendly way of getting around the difficulty of writing large formulas in Notion.
 
 With this tool you can simply write thoroughly compile/type checked typescript logic (with all of Notion's builtin functions) and have it translated to a formula quick and easy!
 
@@ -23,8 +23,9 @@ It does so through these steps:
 8. Return the completed formula
 
 ## Usage
-### NPM
+This guide assumes basic programming proficiency. You don't really need to be a typescript expert but you should be familiar with the concepts of basic logic and polymorphism
 
+### With npm
 Generate a new typescript project:
 
     cd path/to/project
@@ -40,7 +41,7 @@ Then create a MyFirstFormula.ts file that looks something like this:
 
         // fill in your formula function here:
         formula() {
-            if (this.myProperty.value) {
+            if (this.myProperty) {
                 return 1;
             }
             return 0;
@@ -51,10 +52,7 @@ Then create a MyFirstFormula.ts file that looks something like this:
             return 0;
         }
 
-        /**
-        * If you want to use helper functions, define them here like this
-        * @returns
-        */
+        // If you want to use helper functions, define them here like this
         public buildFunctionMap(): Map<string, string> {
             return new Map([
                 ['nameOfFunction', this.nameOfFunction.toString()],
@@ -65,11 +63,13 @@ Then create a MyFirstFormula.ts file that looks something like this:
     const formula = new MyFirstFormula();
     console.log('result: ');
     console.log(formula.compile());
-and add your formula and parameters
+Then just add your formula and parameters and you can run
+
+    ts-node MyFirstFormula.ts
+Easy peasy!
 
-### Cloning the repo (Recommended):
+### with the whole repo (Recommended):
 Because the process for generating formulas is somewhat confusing, it's helpful to have the whole repo at your disposale to view the examples.
-This guide assumes basic programming proficiency. You don't really need to be a typescript expert but you should be familiar with the concepts of basic logic and polymorphism
 
     git clone https://github.com/CharliePalm/Francis
     cd Francis
@@ -80,9 +80,10 @@ Open the provided myFirstFormula file, and run
 you should see the result:
 
     if(prop("myProperty name"),1,0)
-Now that you've confirmed that everything is running smoothly, you can start creating your own formula. You can check out the example file at example.ts for a complicated formula example that uses all the functionality of the compiler, or just fill in the myFirstFormula.ts file with all the functionality you need.
+Now that you've confirmed that everything is running smoothly, you can start creating your own formula. You can check out the example file at example.ts for a complicated formula example that uses all the functionality of the compiler, or just fill in the MyFirstFormula.ts file with all the functionality you need.
 
-DB properties should be defined as they are in the example file. It doesn't matter what you name the variable, but the string you pass in to the constructor MUST be the name of the property. That is to say, in the following example code:
+### General Guidelines
+DB properties should be defined as they are in the example. It doesn't matter what you name the variable, but the string you pass in to the constructor MUST be the name of the property. That is to say, in the following example code:
 
     class Formula extends NotionFormulaGenerator {
         public test = new Model.Number('test2')
@@ -102,9 +103,9 @@ Aside from these exceptions, if typescript compiles you should be good to go.
 
 Note that when adding functions you must create a mapping function to communicate to the compiler what functions to replace with what code. The parent class itself cannot effectively bind each method of the child class at compile time so it's necessary to add this yourself. See the examples in myFirstFormula.ts or example.ts.
 
-You are allowed to reference other functions within helper functions, but cannot use recursion or call to the formula() method. This includes multi method recursion; the chain of method calls cannot contain a cycle.
+You are allowed to reference other functions within helper functions, but cannot use recursion or call to the formula() method. This includes multi method recursion; the chain of method calls cannot contain a cycle, and the compiler will let you know if it encounters one.
 
-If you want to wrap logic in a function call, just execute the logic in a helper function and call it within the function you want to use as the wrapper.
+If you want to wrap logic in a function call (i.e. rounding the result of a calculation), just execute the logic in a helper function and call it within the function you want to use as the wrapper.
 For example:
 
     formula() {
@@ -128,18 +129,11 @@ Alternatively, you can use ternary operators to the same effect:
     }
 Which will lead to the same result, just with ternaries instead of the notion if() function.
 
-
 Above all, this isn't a full complier and shouldn't be treated as such, as the capabilities of Notion formulas are fairly limited. It would be wonderful if the API allowed loops over rollups or dynamic variable definition, it's just not currently possible, and thus I don't see any use cases for things like loops or non-constant variables.
 
-# New in v2.0
-
-Francis has been updated to support Notion's new formula API. This means that you can now utilize object references, callback functions, and update your formulas to be supported by the newest version. Using object references is simple, though does change some ways that Francis needs to be used.
-
-Because DB properties are now treated as objects, if you wish to do any primitive operations, you need to use the .value field on the object (being either a DB property or the return from a function). Otherwise, you can use the object itself as input for things like functions parameters.
-
-Notion also changed some minor things about its builtins - for example: e and pi are now function calls instead of constants, lists have their own functions, concat takes lists, etc.
+# New in v2.0.1
 
-Since they now allow new lines, comments, and other such conveniences, the main purpose of this tool has transitioned into more of a complexity manager. Things like helper function and constant declaration will make writing exceptionally complex formulas much simpler and lead to significant readability improvements. See example.ts for my task scheduler algorithm - it uses two sigmoid functions that are contained in function calls. 
+Francis is now npm ready! Happy formulating!
 
 ## FAQ
 
@@ -161,11 +155,11 @@ You sure can :)\
 
 ## Contributing
 
-Submit a pull request (with unit test coverage please) and I'll happily review it. Otherwise you're free to fork and use as you will for your own PERSONAL purposes. If you use a formula generated by this tool for something that isn't exclusively for yourself please, at the bare minimum give it a shout-out :)
+Submit a pull request (with unit test coverage please) and I'll happily review it. Otherwise you're free to fork and use as you will for your own PERSONAL purposes. If you use a formula generated by this tool for something that isn't exclusively for yourself please, at the bare minimum give francis a shout-out :)
 
 ## Known Bugs
 
-As of 8/5/2023 there are no known bugs.
+As of 9/6/2024 there are no known bugs and 100% unit test coverage.
 
 ## Reporting Bugs
 
@@ -178,4 +172,4 @@ contains a value field that has its primitive type (if applicable) for primitive
 This brings into question how type safety will be properly enforced and how primitive operations can be carried out, which I don't have a solution for right now, but would like to work more on.
 
 ## License
-[MIT License](https://opensource.org/licenses/MIT) 
+[MIT License](https://opensource.org/licenses/MIT)