chore: #337 update readme of packages (#340)

* chore(readme): #337 update readme of packages * chore: bump version for react-app-scaffolder
reapit · Feb 17, 2020 · c2e6fec · c2e6fec
1 parent c081091
commit c2e6fec
Show file tree

Hide file tree

Showing 16 changed files with 99 additions and 21 deletions.
diff --git a/README.md b/README.md
@@ -6,10 +6,10 @@
 
 This is the repository for the Reapit Foundations API, Marketplace, cloud applications and tooling.
 
-* Detailed documentation on all aspects of the platform is available [at this external link](https://wmcvay.gitbook.io/reapit-foundations/).
-* If you are interested in what we are building, head to the [packages directory](https://github.com/reapit/foundations/tree/master/packages).
-* If you want to request a feature, please open an issue [here](https://github.com/reapit/foundations/issues/new?labels=feature-request&projects=reapit/foundations/3&body=Summary%20of%20Request:%0d%0dExpected%20Behaviour). If it is accepted for development, you can track it's progress on our [features board](https://github.com/reapit/foundations/projects/3).
-* If you wish to report a bug, again please [raise an issue](https://github.com/reapit/foundations/issues/new?labels=bug&projects=reapit/foundations/2&body=Summary:%0d%0dSteps%20to%20reproduce:%0d%0dExpected%20Results:%0d%0dActual%20Results). You can track it [here](https://github.com/reapit/foundations/projects/2) as our engineers look into it.
-* If you are interested in our future roadmap, you can see our [project milestones here](https://github.com/reapit/foundations/milestones?direction=asc&sort=due_date&state=open).
+- Detailed documentation on all aspects of the platform is available [at this external link](https://foundations-documentation.reapit.cloud/open-source).
+- If you are interested in what we are building, head to the [packages directory](https://github.com/reapit/foundations/tree/master/packages).
+- If you want to request a feature, please open an issue [here](https://github.com/reapit/foundations/issues/new?labels=feature-request&projects=reapit/foundations/3&body=Summary%20of%20Request:%0d%0dExpected%20Behaviour). If it is accepted for development, you can track it's progress on our [features board](https://github.com/reapit/foundations/projects/3).
+- If you wish to report a bug, again please [raise an issue](https://github.com/reapit/foundations/issues/new?labels=bug&projects=reapit/foundations/2&body=Summary:%0d%0dSteps%20to%20reproduce:%0d%0dExpected%20Results:%0d%0dActual%20Results). You can track it [here](https://github.com/reapit/foundations/projects/2) as our engineers look into it.
+- If you are interested in our future roadmap, you can see our [project milestones here](https://github.com/reapit/foundations/milestones?direction=asc&sort=due_date&state=open).
 
-Please read our [license](./LICENSE.md) and [disclaimer](./DISCLAIMER.md) before proceeding.
+Please read our [license](./LICENSE.md) and [disclaimer](./DISCLAIMER.md) before proceeding.
diff --git a/packages/aml-checklist/README.md b/packages/aml-checklist/README.md
@@ -2,4 +2,11 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/aml-checklist).
+An anti-money laundering app, aimed at helping negotiators gather identity checking information from clients and applicants.
+
+- **Tech Stack**: React, Redux, React Router, Elements, Cognito Auth, Jest, Sass / CSS Modules.
+- **Cloud Services**: S3, CloudFront, AWS Cognito, SecretsManager, Sentry
+- **Production**: https://aml-app.reapit.cloud
+- **Development**: https://dev.aml-app.reapit.cloud
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#aml-checklist).
diff --git a/packages/cognito-auth/README.md b/packages/cognito-auth/README.md
@@ -2,4 +2,10 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/cognito-auth).
+A thin wrapper around the AWS SDK and OAuth flow to take the pain out of authenticating your App with Reapit Connect. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#cognito-auth).
+
+- **Tech Stack**: AWS JavaScript SDK
+- **Cloud Services**: NPM, AWS Cognito
+- **Production**: https://www.npmjs.com/package/@reapit/elements
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#cognito-auth).
diff --git a/packages/cognito-custom-mail-lambda/README.md b/packages/cognito-custom-mail-lambda/README.md
@@ -2,4 +2,9 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/cognito-custom-mail-lambda).
+Lambda that intercepts Cognito Emails and applies custom Reapit response.
+
+- **Tech Stack**: Serverless, EJS, NodeJS
+- **Cloud Services**: CloudForm, AWS Lambda
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#cognito-custom-mail-lambda).
diff --git a/packages/config-manager/README.md b/packages/config-manager/README.md
@@ -1,3 +1,9 @@
 # Config Manager
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/config-manager).
+A thin wrapper around AWS Secrets Manager for keeping remote config secure. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#config-manager).
+
+- **Tech Stack**: AWS SDK
+- **Cloud Services**: NPM, AWS Secrets Manager
+- **Production**: https://www.npmjs.com/package/@reapit/config-manager
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#config-manager).
diff --git a/packages/demo-site/README.md b/packages/demo-site/README.md
@@ -1,3 +1,7 @@
 # Demo Site
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/demo-site).
+A simple HTML app for deploying Reapit Web Components.
+
+Under active development pre-alpha.
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#demo-site).
diff --git a/packages/elements/README.md b/packages/elements/README.md
@@ -2,4 +2,10 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/elements).
+A UI toolkit for building web applications in the Reapit Marketplace. Exports a library of React Components, JavaScript and TypeScript utilities and a CSS Stylesheet. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#elements).
+
+- **Tech Stack**: React, Bulma, StoryBook, Sass / CSS Modules.
+- **Cloud Services**: Github Pages
+- **Production**: https://reapit.github.io/elements/
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#elements).
diff --git a/packages/foundations-ts-definitions/README.md b/packages/foundations-ts-definitions/README.md
@@ -1,3 +1,9 @@
 # Foundations TS Definitions:
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/foundations-ts-defintions).
+Automated TypeScript definitions for the Foundations API Platform. Automatically generates up to date TypeScript type definitions from Platform API swagger documentation. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#foundations-ts-definitions).
+
+- **Tech Stack**: NodeJS
+- **Cloud Services**: NPM
+- **Production**: https://www.npmjs.com/package/@reapit/foundations-ts-definitions
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#foundations-ts-definitions).
diff --git a/packages/geo-diary/README.md b/packages/geo-diary/README.md
@@ -2,4 +2,11 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/geo-diary).
+An app for negotiators on the go. It geo locates the user and assists them with their daily appointments by getting them from A to B.
+
+- **Tech Stack**: React, Redux, React Router, Elements, Cognito Auth, Jest, Sass / CSS Modules.
+- **Cloud Services**: S3, CloudFront, AWS Cognito, SecretsManager, Sentry
+- **Production**: https://dev.geo-diary-app.reapit.cloud
+- **Development**: https://geo-diary-app.reapit.cloud
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#geo-diary).
diff --git a/packages/graphql-server/README.md b/packages/graphql-server/README.md
@@ -1,3 +1,7 @@
 # GraphQL Server
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/graphql-server).
+A GraphQL implementation of the Foundations API.
+
+Under active development pre-alpha.
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#graphql-server).
diff --git a/packages/lifetime-legal/README.md b/packages/lifetime-legal/README.md
@@ -2,4 +2,11 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/lifetime-legal).
+Fork of AML App, to extend functionality for Lifetime Legal client.
+
+- **Tech Stack**: React, Redux, React Router, Elements, Cognito Auth, Jest, Sass / CSS Modules.
+- **Cloud Services**: S3, CloudFront, AWS Cognito, SecretsManager, Sentry
+- **Production**: https://lifetime-legal-app.reapit.cloud
+- **Development**: https://dev.lifetime-legal-app.reapit.cloud
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#lifetime-legal).
diff --git a/packages/marketplace/README.md b/packages/marketplace/README.md
@@ -2,5 +2,11 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/marketplace).
+The core frontend of the Reapit Foundations platform. Contains all functionality in both the Marketplace and Developer Portal applications.
 
+- **Tech Stack**: React, Redux, React Router, Elements, Cognito Auth, Jest, Cypress, Sass / CSS Modules.
+- **Cloud Services**: S3, CloudFront, AWS Cognito, SecretsManager, Sentry
+- **Production**: https://marketplace.reapit.cloud
+- **Development**: https://dev.marketplace.reapit.cloud
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#marketplace).
diff --git a/packages/react-app-scaffolder/README.md b/packages/react-app-scaffolder/README.md
@@ -1,3 +1,9 @@
 # Reapit React-Redux App Scaffolder
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/react-app-scaffolder).
+A CLI for generating React Apps, optimised for the marketplace, including Reapit Connect authentication and Elements. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#react-app-scaffolder).
+
+- **Tech Stack**: Yeoman, React, Redux, Jest, React, Router, Styled-Components, Sass, CSS Modules
+- **Cloud Services**: NPM
+- **Production**: https://www.npmjs.com/package/@reapit/generator-react-redux-app
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#react-app-scaffolder).
diff --git a/packages/react-app-scaffolder/package.json b/packages/react-app-scaffolder/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@reapit/generator-react-app-scaffolder",
-  "version": "0.0.17",
+  "version": "0.0.18",
   "description": "An opinionated gnerator for scaffolding TypeScript React Redux apps",
   "keywords": [
     "yeoman-generator"

diff --git a/packages/smb/README.md b/packages/smb/README.md
@@ -1,3 +1,7 @@
 # Small Medium Business App
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/smb-app).
+An application to onboard new businesses to the Reapit Agency Cloud CRM.
+
+Under active development pre-alpha.
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#smb-small-businesses-app).
diff --git a/packages/web-components/README.md b/packages/web-components/README.md
@@ -2,4 +2,8 @@
 
 ![lines](./src/tests/badges/badge-lines.svg) ![functions](./src/tests/badges/badge-functions.svg) ![branches](./src/tests/badges/badge-branches.svg) ![statements](./src/tests/badges/badge-statements.svg)
 
-For detailed documentation [visit here](https://wmcvay.gitbook.io/reapit-foundations/open-source/packages/web-components).
+Embeddable TypeScript widgets to enhance static sites. For usage visit [here](https://foundations-documentation.reapit.cloud/api/web#search-component).
+
+Under active development pre-alpha.
+
+For detailed documentation [visit here](https://foundations-documentation.reapit.cloud/open-source/packages#web-components).