From e3b3035359c57cd07cd3608d1db4fa892ab4c885 Mon Sep 17 00:00:00 2001 From: Taylor Reece Date: Fri, 6 Dec 2024 15:08:27 -0600 Subject: [PATCH] Update README (#97) --- LICENSE | 2 +- README.md | 46 +++++++++++++++++++--------------- example-embedded-app/README.md | 4 +-- package.json | 2 +- 4 files changed, 30 insertions(+), 24 deletions(-) diff --git a/LICENSE b/LICENSE index 5dc9682..be7fd8d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Prismatic.io +Copyright (c) 2024 Prismatic.io Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b4bf9f4..a86f92b 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,43 @@ -# @prismatic-io/embedded +
+ +

@prismatic-io/embedded

+
-`@prismatic-io/embedded` allows you to to embed Prismatic's [Application](https://prismatic.io/docs/embedding-marketplace/) within your web application, giving your customers the ability to manage integrations, instances, and components you've built in Prismatic. +`@prismatic-io/embedded` allows you to to embed Prismatic's [integration marketplace](https://prismatic.io/docs/instances/integration-marketplace/) and [workflow designer](https://prismatic.io/docs/embed/workflow-designer/) within your web application, giving your customers the ability to manage integrations, instances, and connectors you've built in Prismatic. ## What is Prismatic? -Prismatic is the integration platform for B2B software companies. It's the quickest way to build integrations to the other apps your customers use and to add a native integration marketplace to your product. +Prismatic is the leading embedded iPaaS, enabling B2B SaaS teams to ship product integrations faster and with less dev time. The only embedded iPaaS that empowers both developers and non-developers with tools for the complete integration lifecycle, Prismatic includes low-code and code-native building options, deployment and management tooling, and self-serve customer tools. -Prismatic significantly reduces overall integration effort and enables non-dev teams to take on more of the integration workload, so that you can deliver integrations faster and spend more time on core product innovation. +Prismatic's unparalleled versatility lets teams deliver any integration from simple to complex in one powerful platform. SaaS companies worldwide, from startups to Fortune 500s, trust Prismatic to help connect their products to the other products their customers use. With Prismatic, you can: -- Build reusable [integrations](https://prismatic.io/docs/integrations) in a low-code integration designer that's tailored for your product -- Use [pre-built components](https://prismatic.io/docs/components/component-catalog) to handle most of your integrations' functionality, and write [custom components](https://prismatic.io/docs/custom-components/writing-custom-components) when needed -- Quickly add an [integration marketplace](https://prismatic.io/docs/integration-marketplace) to your product so customers can explore, activate, and monitor integrations -- Easily deploy customer-specific integration [instances](https://prismatic.io/docs/instances) with unique configurations and connections -- Provide better support with tools like [logging](https://prismatic.io/docs/logging) and [alerting](https://prismatic.io/docs/monitoring-and-alerting) -- Run your integrations in a purpose-built environment designed for security and scalability -- Use powerful dev tools to mold the platform to your product, industry, and the way you build software +- Build [integrations](https://prismatic.io/docs/integrations/) using our [intuitive low-code designer](https://prismatic.io/docs/integrations/low-code-integration-designer/) or [code-native](https://prismatic.io/docs/integrations/code-native/) approach in your preferred IDE +- Leverage pre-built [connectors](https://prismatic.io/docs/components/) for common integration tasks, or develop custom connectors using our TypeScript SDK +- Embed a native [integration marketplace](https://prismatic.io/docs/embed/) in your product for customer self-service +- Configure and deploy customer-specific integration instances with powerful configuration tools +- Support customers efficiently with comprehensive [logging, monitoring, and alerting](https://prismatic.io/docs/monitor-instances/) +- Run integrations in a secure, scalable infrastructure designed for B2B SaaS +- Customize the platform to fit your product, industry, and development workflows ## Who uses Prismatic? -Prismatic is for B2B (business-to-business) software companies, meaning software companies that provide applications used by businesses. It's a good fit for products/teams ranging from early-stage and growing SaaS startups to large, established software companies looking to improve the way they do integrations. +Prismatic is built for B2B software companies that need to provide integrations to their customers. Whether you're a growing SaaS startup or an established enterprise, Prismatic's platform scales with your integration needs. -Many B2B software teams serve customers in niche vertical markets, and we designed Prismatic with that in mind. We provide powerful and flexible tools so you can build exactly the integrations your customers need, no matter who your customers are, no matter what systems you need to connect to, no matter how "non-standard" your integration scenario. +Our platform is particularly powerful for teams serving specialized vertical markets. We provide the flexibility and tools to build exactly the integrations your customers need, regardless of the systems you're connecting to or how unique your integration requirements may be. ## What kind of integrations can you build using Prismatic? -Prismatic supports integrations ranging from simple and standard to complex, bespoke, and vertical-specific. -Teams use it to build integrations between applications of all kinds, SaaS or legacy, with or without a modern API, regardless of protocol or data format. -Here are some example use cases: +Prismatic supports integrations of any complexity - from simple data syncs to sophisticated, industry-specific solutions. Teams use it to build integrations between any type of system, whether modern SaaS or legacy with standard or custom protocols. Here are some example use cases: -- Use job data from your system to create invoices in your customers' ERP. -- Import and process data from third-party forms that vary significantly from customer to customer. -- Email activity summary reports with parameters and intervals defined on a per-customer basis. +- Connect your product with customers' ERPs, CRMs, and other business systems +- Process data from multiple sources with customer-specific transformation requirements +- Automate workflows with customizable triggers, actions, and schedules +- Handle complex authentication flows and data mapping scenarios -For information on the Prismatic platform, check out our [website](https://prismatic.io) and [docs](https://prismatic.io/docs). +For information on the Prismatic platform, check out our [website](https://prismatic.io/) and [docs](https://prismatic.io/docs/). + +## License + +This repository is MIT licensed. diff --git a/example-embedded-app/README.md b/example-embedded-app/README.md index e176119..023c76c 100644 --- a/example-embedded-app/README.md +++ b/example-embedded-app/README.md @@ -2,7 +2,7 @@ This directory contains an example NextJS/React application that embeds the Prismatic SDK. It contains examples of how to embed the integration marketplace and integration designer, as well as additional examples for dynamically setting config variables, pulling additional data from Prismatic's GraphQL API, and more. -For documentation on installing the Prismatic embedded SDK in your app, see the [Prismatic docs](https://prismatic.io/docs/installing-embedded/). +For documentation on installing the Prismatic embedded SDK in your app, see the [Prismatic docs](https://prismatic.io/docs/embed/get-started/install-embedded-sdk/). ## Important files @@ -21,7 +21,7 @@ To run this example embedded application yourself, ensure that you have a modern Next, make a copy of `prismatic/config.ts.template` called `prismatic/config.ts`. Populate `prismatic/config.ts` with the information you need to generate JWT tokens for customer user authentication: -- Replace `signingKey` with a signing key that you generate [in Prismatic](https://prismatic.io/docs/installing-embedded/#jwt-signing-keys). +- Replace `signingKey` with a signing key that you generate [in Prismatic](https://prismatic.io/docs/embed/authenticate-users/#jwt-signing-keys). - If your tenant is not in the US commercial region, replace `prismaticUrl` with your tenant's region. - Replace `sub` with a unique customer ID for your customer user. - Replace `organization` with your organization's ID, which you can find on the same page where you generated the signing key. diff --git a/package.json b/package.json index 2a63e61..f96d68b 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@prismatic-io/embedded", - "description": "Embed your prismatic.io application within your existing application.", + "description": "Embed Prismatic's integration marketplace and workflow designer within your existing application.", "keywords": [ "prismatic", "marketplace",