react-app-modules - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

dist/index.d.ts

@@ -5,2 +5,2 @@ export { AppContext } from './app-context';
 export { useModule } from './use-module';
-export type { Types } from './types';
+export { Types } from './types';

package.json

 {
   "name": "react-app-modules",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "main": "dist/index.js",
@@ -11,3 +11,3 @@ "types": "dist/index.d.ts",
     "clean": "npx rimraf dist",
-    "prepublish": "yarn build",
+    "prepublish": "yarn build && yarn test",
     "test": "jest"
@@ -14,0 +14,0 @@ },

README.md

@@ -1,11 +0,68 @@
-## Installing Dependencies / Building
+# react-app-modules
 
+An easy-to-use, type-safe IoC library for React apps.
+
+### Features
+
+- *Type-Free Syntax*: complete type-safety with **no** generics / parameterization
+- *Observable Architecture*: providers can be made extremely flexible, modules can be swapped out live
+- *Custom Hooks*: modules can be loaded within functional components
+- *Symbol Names*: easy to rename modules using standard refactoring tools
+- *Written in TypeScript*: no need to add an `@types` package ;)
+
+### Not Currently Supported
+
+- Lazy loading
+- Class components
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Installation](#installation)
+- [Tutorial](#tutorial)
+- [Development](#development)
+  - [Dependencies](#dependencies)
+  - [Build](#build)
+  - [Test](#test)
+  - [Publish](#publish)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+## Installation
+
+```bash
+# npm
+npm install react-app-modules
+
+# yarn
+yarn add react-app-modules
+```
+
+## Tutorial
+
+Coming soon...
+
+## Development
+
+### Dependencies
+
     yarn
 
-## Testing
+### Build
 
+    yarn build
+
+### Test
+
     yarn test
 
-## Publishing
+### Publish
 
     yarn publish
+
+## Misc
+
+### Update README Table of Contents
+
+    npx doctoc README.md

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

8053

increased by18.81%

Number of lines in readme file

69

increased by475%

No dependency changes