Update docs

Author: snasir-stripe

.editorconfig

@@ -8,4 +8,4 @@ trim_trailing_whitespace = true
 insert_final_newline = true
 
 [*.md]
-trim_trailing_whitespace = false
+trim_trailing_whitespace = false

CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to make participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies within all project spaces, and it also applies when
+an individual is representing the project or its community in public spaces.
+Examples of representing a project or community include using an official
+project e-mail address, posting via an official social media account, or acting
+as an appointed representative at an online or offline event. Representation of
+a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at conduct@stripe.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+
+Contributions of any kind are welcome! If you've found a bug or have a feature request, please feel free to [open an issue](https://github.com/stripe-samples/issuing-treasury/issues).
+
+To make changes yourself, follow these steps:
+
+1. [Fork](https://help.github.com/articles/fork-a-repo/) this repository and [clone](https://help.github.com/articles/cloning-a-repository/) it locally.
+2. Make your changes
+3. Submit a [pull request](https://help.github.com/articles/creating-a-pull-request-from-a-fork/)
+
+## Contributor License Agreement ([CLA](https://en.wikipedia.org/wiki/Contributor_License_Agreement))
+
+Once you have submitted a pull request, sign the CLA by clicking on the badge in the comment from [@CLAassistant](https://github.com/CLAassistant).
+
+<img width="910" alt="image" src="https://user-images.githubusercontent.com/62121649/198740836-70aeb322-5755-49fc-af55-93c8e8a39058.png">
+
+<br />
+Thanks for contributing to Stripe! :sparkles:

README.md

@@ -1,95 +1,108 @@
-# Example Stripe Issuing and Treasury integration demonstrating Embedded Finance
+# Stripe Issuing and Treasury: An Embedded Finance Example
 
-This demo is an application that allows you to quickly experiment with an Embedded Finance experience using Stripe Issuing & Treasury APIs.
+This demo application enables users to work with an Embedded Finance experience, utilising Stripe's Issuing and Treasury APIs.
 
-With this application, you can:
+The application provides the following features:
 
-- Sign up for a Stripe [Custom connect](https://stripe.com/docs/connect/custom-accounts) Account and for a Stripe Treasury Financial Account
-- Onboard using [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding) for Custom accounts
-- Display the Financial Account Balance
-- Display a chart to quickly visualize funds coming in and coming out
-- Display a transaction report
-- Create a cardholder and issue a card, using the Financial Account as the source of funds
-- Display the issued card information in a compliant manner by leveraging Stripe Elements
-- Display the Financial Account's Routing and Account numbers
-- Send money from the Financial Account, either using ACH or Wire Transfers
+- Creation of a Stripe [Custom connect](https://stripe.com/docs/connect/custom-accounts) Account and a Stripe Treasury Financial Account.
+- Use of [Connect Onboarding](https://stripe.com/docs/connect/connect-onboarding) for Custom accounts setup.
+- Financial Account balance display.
+- Visualisation of incoming and outgoing funds via a chart.
+- Transaction report display.
+- Cardholder creation and card issuing, with the Financial Account serving as the funds source.
+- Compliance-maintained card information display using Stripe Elements.
+- Display of Financial Account's Routing and Account numbers.
+- Money transfer from the Financial Account with ACH or Wire Transfers.
 
-In addition to these functions, there is also a *Test Data* section that will help platforms understanding the different mechanisms to fund Financial Accounts by:
+Additionally, a *Test Data* section helps to understand different mechanisms for funding Financial Accounts, by simulating the following:
 
-- Simulating receiving a Transfer from an external account to a Financial Account.
+- Transfer reception from an external account to a Financial Account.
 - Creating a PaymentLink and then, paying out funds from the Connected Account balance to the Financial Account Balance.
-<!-- You can watch a recorded live stream about this demo [here](https://www.youtube.com/watch?v=2MiMFJ9c4t8). -->
 
-## Requirements
+## Prerequisites
 
-- **A Stripe account**: You can sign up for a Stripe account here: <https://dashboard.stripe.com/register>
-- **Onboard onto Issuing and Treasury**:
-  - Issuing: [Instant Testmode](https://dashboard.stripe.com/setup/issuing/activate)
-  - Treasury: [Please contact sales](https://go.stripe.global/treasury-inquiry)
-- **Stripe API keys**: Available in your Stripe dashboard here: <https://dashboard.stripe.com/test/apikeys>
+- **A Stripe account**: Register for a Stripe account here: <https://dashboard.stripe.com/register>
+- **Enable Issuing and Treasury in Stripe**:
+  - Issuing: Use [Instant Testmode](https://dashboard.stripe.com/setup/issuing/activate)
+  - Treasury: [Contact sales](https://go.stripe.global/treasury-inquiry)
+- **Stripe API keys**: Obtain your keys via <https://dashboard.stripe.com/test/apikeys>
 
-## No-code deploy demo to Render.com
+## Deploy demo on Render.com
 
-You can deploy this sample app directly to Render.com using the button below. This way you can try it out for yourself 
-quickly and without any coding. The button below will create a free database and web service instance.
+To deploy this sample application directly in Render, click on the button below. It automatically logs into Render and
+initiates setup with a free database and web service instance. No coding required.
 
 [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/stripe-samples/issuing-treasury)
 
-When prompted, enter:
+Upon prompt, please provide:
 
-* **Blueprint Name**: This can be anything (e.g. "Demo")
-* **Under Key / Value**:
-  * **STRIPE_SECRET_KEY**: Your Stripe account's testmode API key
-  * **NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY**: Your Stripe account's testmode publishable key
+- **Blueprint Name**: Enter any name (e.g., "Demo")
+- **Under Key / Value**:
+  - **STRIPE_SECRET_KEY**: Enter your Stripe testmode API key
+  - **NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY**: Enter your Stripe testmode publishable key
 
-Once you click "Apply", the infrastructure will begin spinning up. After approximately 5 minutes, click on the link to
-"issuing-treasury" on the page to go to the web service. There, you'll see a link at the top to the URL. It'll look
-something like "https://issuing-treasury-12gj.onrender.com".
+After around 5 minutes, click on the "issuing-treasury" link to access your deployed web service.
 
-## Local installation instructions
+## Local Installation
 
-### Installing the dependencies
+### Dependency Installation
 
-After cloning this repo, install the dependencies.
+Post cloning this repo, install the dependencies using:
 
     npm install
 
-### Populating your .env file
+### .env File Setup
 
-Copy the `.env.example` file on the root of your project to `.env`:
+Replicate `.env.example` as `.env` (in project root directory) using:
 
     cp .env.example .env
 
-Edit your new `.env` file and update the required information:
+Update `.env` to reflect:
 
-- **STRIPE_SECRET_KEY**: Your Stripe private key.
-- **NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY**: Your Stripe publishable key.
-- **NEXTAUTH_SECRET**: Used to encrypt the NextAuth.js JWT ([learn more](https://next-auth.js.org/configuration/options#nextauth_secret)). You can use `openssl rand -base64 32` to generate a new one.
-- **CONNECT_ONBOARDING_REDIRECT_URL**: The host where your application will run (if local you can use `"http://localhost:3000"`)
+- **STRIPE_SECRET_KEY**: Your Stripe private key
+- **NEXT_PUBLIC_STRIPE_PUBLISHABLE_KEY**: Your Stripe publishable key
+- **NEXTAUTH_SECRET**: For JWT encryption by NextAuth.js ([learn more](https://next-auth.js.org/configuration/options#nextauth_secret)). Use `openssl rand -base64 32` to obtain a new one
+- **CONNECT_ONBOARDING_REDIRECT_URL**: Your application host, for local use, use "<http://localhost:3000>"
 
-### Setting up the database
+### Database Setup
 
-On a Mac, follow these instructions to install Postgres:
+On Mac, follow these instructions to install Postgres:
 
     brew install postgresql@14
     createuser -s postgres
 
-You can learn more about the `createuser` step [here](https://stackoverflow.com/a/15309551).
+You'll find more about the `createuser` step [here](https://stackoverflow.com/a/15309551).
 
-Now you need to create the database:
+Next, create the database with:
 
     npx prisma db push
 
-If this fails for any reasons such as permissions being denied, there's an included idempotent script you can run:
+If it errors out (perhaps due to permission issues), simply run the included script:
 
     ./db/setup-database.postgres.sh
 
-This will create a `issuing_treasury` database in your local Postgres instance.
+This script creates a local Postgres `issuing_treasury` database.
 
-### Running the application
+### Application Launch
 
-In order to run the application, after you installed the dependencies and created the `.env` file run the following command:
+After necessary setups, launch the application with `npm run dev`.
 
-    npm run dev
+*Note: This application serves as an example and should not proceed to production deployment as it is.*
 
-*Notice: This application is intended to be an example, and it should not be run in production as is.*
+## Acknowledgment to Devias Theme
+
+The Devias theme significantly contributed to the swift construction of this sample app. Besides providing an elegant display, Devias offers a streamlined integration with Material UI. The effective utilization of this free theme allowed us to deliver a high-quality and engaging sample app.
+
+## Accelerating Development with Devias Pro
+
+Although the free Devias theme was instrumental in building this sample application, for developers who are aiming for a full-featured, production-ready application, we recommend the Devias Pro version.
+
+Devias Pro extends beyond the capacity of the free version, providing an extensive array of advanced components and features designed to expedite and enrich your development process. With Devias Pro, you gain access to additional layouts, advanced React components, and pre-built dashboards, not to mention TypeScript support that underpins clean, robust, and scalable code.
+
+One of the key advantages of Devias Pro is its inclusion of Figma design files. These files empower developers to efficiently build complex user experiences with precision and consistency. The design resources and components available in Devias Pro are patterned after modern UX/UI best practices, providing a smooth, optimized user experience out of the box.
+
+By choosing Devias Pro, you're not just getting a theme; you're getting a robust toolset designed to help you turn your ideas into fully fledged, industrial-strength applications faster. It's a springboard that propels your project from its inception to a production-ready state in less time.
+
+We appreciate the pivotal role Devias themes have played in the development of this sample app, and wholeheartedly recommend a step up to Devias Pro for developers keen on accelerating their development cycles, improving the overall quality of their products, and delivering a top-tier user experience.
+
+You can explore and experience the prodigious benefits of Devias Pro [here](https://material-kit-pro-react.devias.io/).