diff --git a/.dockerignore b/.dockerignore index 8567ba47c..0009d500b 100644 --- a/.dockerignore +++ b/.dockerignore @@ -27,4 +27,3 @@ yarn.lock dist *.css.d.ts __generated__ -README.md.orig diff --git a/.gitignore b/.gitignore index 5f07a743c..78a0625cf 100644 --- a/.gitignore +++ b/.gitignore @@ -20,5 +20,4 @@ yarn.lock dist *.css.d.ts __generated__ -README.md.orig persisted-queries.json diff --git a/README.md b/README.md index 6f5151e3a..a2100791c 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,52 @@ -# Coral  +
-Online comments are broken. Our open-source commenting platform, Coral, rethinks -how moderation, comment display, and conversation function, creating the -opportunity for safer, smarter discussions around your work. -[Read more about Coral here](https://coralproject.net/talk). ++ A better commenting experience from Vox Media. +
-Built with <3 by the Coral team, a part of [Vox Media](https://product.voxmedia.com/). + -Preview Coral easily by running it via a Heroku App: +## Description -[](https://heroku.com/deploy?template=https://github.com/coralproject/talk) +Online comments are broken. Our open-source commenting platform, +[Coral](https://coralproject.net), rethinks how moderation, comment display, and +conversation function, creating the opportunity for safer, smarter discussions +around your work. - - -## Table of Contents - -- [Documentation](#documentation) -- [Pre-Launch Guide](#pre-launch-guide) -- [More Resources](#more-resources) -- [License](#license) - - +We offer hosting and support packages for Coral, as well as exclusive, +customer-only features. [Contact us](https://coralproject.net/pricing/) for more +information or [sign up for a webinar](https://coralproject.net). ## Documentation -You can get started with Coral using our [Documentation](https://docs.coralproject.net/talk/). +If you're new to Coral, the [Coral documentation](https://docs.coralproject.net/) +is a great place to start running and developing with Coral. -## Pre-Launch Guide +You’ve installed Coral, and you’re preparing to launch it on your site. The real +community work starts now, before you go live. You have a unique opportunity +pre-launch to set your community up for success. Read our +[Community Guides](https://guides.coralproject.net/start-here/) to learn more. -You’ve installed Coral on your server, and you’re preparing to launch it on your site. The real community work starts now, before you go live. You have a unique opportunity pre-launch to set your community up for success. Read our [Community Guides](https://guides.coralproject.net/start-here/) to learn more. +## Support -## More Resources +We can help you set up Coral, migrate your comments from another system, +integrate your registration platform, pair with your programmers, and help you +with bespoke installs. To learn more, [contact us](https://coralproject.net/pricing/). -- [Learn more about Coral and sign up for a webinar](https://coralproject.net/) +## Contributing + +Coral is a Apache-2.0 licensed open-source project built with <3 by the Coral +team, a part of [Vox Media](https://product.voxmedia.com/). + +If you are interested in contributing to Coral, check out our [Contributor's Guide](CONTRIBUTING.md). ## License -Coral is released under the [Apache License, v2.0](/LICENSE). +Coral is [Apache-2.0 licensed](LICENSE). diff --git a/package.json b/package.json index ec22cb40b..1a4e0cacb 100644 --- a/package.json +++ b/package.json @@ -29,7 +29,7 @@ "migration:create": "ts-node --transpile-only ./scripts/migration/create.ts", "docs:events": "ts-node ./scripts/generateEventDocs.ts ./src/core/client/stream/events.ts ./CLIENT_EVENTS.md", "docs:css-variables": "ts-node ./scripts/generateCSSVariablesDocs.ts ./src/core/client/ui/theme/streamVariables.ts ./CSS_VARIABLES.md", - "doctoc": "doctoc --maxlevel=3 --title '## Table of Contents' README.md CLIENT_EVENTS.md CONTRIBUTING.md WEBHOOKS.md EXTERNAL_MODERATION_PHASES.md", + "doctoc": "doctoc --maxlevel=3 --title '## Table of Contents' CLIENT_EVENTS.md CONTRIBUTING.md WEBHOOKS.md EXTERNAL_MODERATION_PHASES.md", "generate": "npm-run-all generate:css-types generate:schema generate:relay", "generate-persist": "npm-run-all generate:css-types generate:schema generate:relay-persist", "generate:css-types": "tcm src/core/client/", @@ -434,7 +434,7 @@ "{src/core/client/ui/theme/sharedVariables.ts,src/core/client/ui/theme/streamVariables.ts,scripts/generateCSSVariablesDocs.ts,CSS_VARIABLES.md}": [ "npm run docs:css-variables -- --verify" ], - "{README,CLIENT_EVENTS,CONTRIBUTING,WEBHOOKS,EXTERNAL_MODERATION_PHASES}.md": [ + "{CLIENT_EVENTS,CONTRIBUTING,WEBHOOKS,EXTERNAL_MODERATION_PHASES}.md": [ "npm run doctoc" ] },