Skip to content

Commit

Permalink
Updated the README file; converted README to Markdown.
Browse files Browse the repository at this point in the history
The README file was still in the "asciidoc" format, and to make it consistent
with the rest of the project.

This also updated the logo to its current form, as well as only have the logo
referenced in one place in the repository.
  • Loading branch information
Jonathan S. Katz authored and jkatz committed Nov 4, 2019
1 parent 270f218 commit ec1a984
Show file tree
Hide file tree
Showing 3 changed files with 31 additions and 28 deletions.
28 changes: 0 additions & 28 deletions README.adoc

This file was deleted.

31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
<h1 align="center">Crunchy Container Suite</h1>

<p align="center">
<img width="300" src="./images/crunchy_logo.png?raw=true"/>
</p>

## General

The Crunchy Container Suite provides Docker containers that enable rapid deployment of PostgreSQL, including administration and monitoring tools. Multiple styles of deploying PostgreSQL clusters are supported.

Please view the official Crunchy Data Container Suite [documentation](https://access.crunchydata.com/documentation/crunchy-containers/):

https://access.crunchydata.com/documentation/crunchy-containers/

If you are interested in contributing, please read the Contribution Guidelines.

## Getting Started

Complete build and install documentation is found [here](https://access.crunchydata.com/documentation/crunchy-containers/latest/installation-guide/). The provided Dockerfiles build the containers on a Centos 7 base image and use the community PostgreSQL RPMs.

Crunchy provides a commercially supported version of these containers built upon RHEL 7 and the Crunchy supported PostgreSQL. Contact Crunchy for more details at:

[https://www.crunchydata.com/contact/](https://www.crunchydata.com/contact/)

Further descriptions of each of these containers and environment variables that can be used to tune them can be found in the [Container Specifications](https://access.crunchydata.com/documentation/crunchy-containers/latest/container-specifications/) document.

## Usage

Various examples are provided in the [Examples](https://access.crunchydata.com/documentation/crunchy-containers/latest/examples/) documentation for running in Docker, Kubernetes, and OpenShift environments.

You will need to set up your environment as per the [Installation](https://access.crunchydata.com/documentation/crunchy-containers/latest/installation-guide/) documentation in order to execute the examples.
Binary file modified images/crunchy_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit ec1a984

Please sign in to comment.