Merge pull request #7 from MFB-Technologies-Inc/fix-published-package

Fix published package

Author: lemke-ethan

.github/workflows/publish.yml

@@ -20,9 +20,9 @@ jobs:
       - name: Install packages
         run: npm install
 
-      - name: Check formatting
-        run: npm run check-formatting
-
+      - name: Build project and dependencies
+        run: npm run build
+      
       - name: Run unit tests and generate report
         run: npm run test:ci
 

CONTRIBUTING.md

@@ -16,8 +16,11 @@ At the core of this package is `createAsyncRenderer`, which renders specific JSX
 
 ```tsx
 function useMyData() {
+  // Setup status state to reflect the state of your long running process
   const [status, setStatus] = useState<AsyncRequestStatus>(AsyncRequestStatus.INIT)
+  // Setup error state for any errors associated with your long running process
   const [error, setError] = useState<null | string>(null)
+  // Setup data state for any data returned from your long running process
   const [data, setData] = useState<null | string>(null)
 
   // Logic to kick off a request for data and update local state respectively...
@@ -31,6 +34,7 @@ function useMyData() {
 
 function MyDataComponent() {
   const myData = useMyData()
+  // Create a renderer for your long running process
   const loadingRenderer = createAsyncRenderer({
     status: myData.status,
     error: myData.error,
@@ -86,9 +90,11 @@ These other utility functions can be used to simplify the logic around `createAs
 - `getCascadedAsyncState`: Reduces a chain of asynchronous request objects down one asynchronous request object.
 - `getOptimisticAsyncLoadState`: Converts its arguments into an optimistic asynchronous request object such that if the arguments indicate a pending asynchronous request and a fulfilled asynchronous request, then the result is a fulfilled asynchronous request object.
 
-## Contributing
+Checkout the [example application](./example/README.md).
 
-[Contributing](./CONTRIBUTING.md)
+## License
+
+[MIT License](./LICENSE)
 
 ## Changelog
 

README.md

@@ -0,0 +1,23 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# production
+/build
+
+# misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

example/.gitignore

@@ -0,0 +1,5 @@
+# example
+
+Example of how to use the exports of `@mfbtech/react-async-renderer`.
+
+Requires `@mfbtech/react-async-renderer` to be packed. Run `npm run package` in the parent directory to pack `@mfbtech/react-async-renderer`.