Skip to content

Commit

Permalink
Last touches
Browse files Browse the repository at this point in the history
  • Loading branch information
jaredpetersen committed Sep 3, 2015
1 parent c79cb2c commit 5817613
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 4 deletions.
7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,16 @@ The Continuous Delivery Performance Promotion Tool is a Python program that is u

# Getting Started

## Installation
## Installation (Basic)
1. Run ``pip install cd_perf_promotion``
2. You're done!

## Installation (Advanced)
1. Make sure that you have the latest version of Python and Pip installed and that you can run both via your command-line interface (CLI).
2. Download the source code and navigate to it using your CLI.
3. Inside the cd_perf_promotion downloaded directory, run ``python setup.py install`` to begin installation.
4. The application will download the necessary dependencies via Pip and install itself. You will now be able to run the program from your CLI via the command ``cdperfpromotion``.
5. You're done!

## Defining Your Promotion Criteria
Your ``config.json`` file contains all of the configuration information that the tool needs to retrieve data from your performance tools and evaluate whether your application meets your performance standards. We've provided some sample configuration files (located in ``documentation/sample_configs/input``) to help you get started. A complete list of all of the available data items that can be used to evaluate the performance of your application and information on what they really mean is available in the ``dictionary.md`` file inside the ``documentation`` directory.
Expand Down
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,12 @@

setup(
name = "cd_perf_promotion",
version = "0.1",
description = "Continuous Delivery Performance Promotion Tool",
version = "1.0.0",
description = "Evaluate and promote builds on a CI/CD platform based on performance",
author = "Jared Petersen",
author_email = "[email protected]",
license = "Copyright 2015 CDK Global, LLC",
url = "https://github.com/CDKGlobal/cd-performance-promotion",
license = "MIT",
packages = ["cd_perf_promotion",
"cd_perf_promotion.engines",
"cd_perf_promotion.modules"],
Expand Down

0 comments on commit 5817613

Please sign in to comment.