Skip to content

README update #16

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 16, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 28 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,17 +350,6 @@ task:
It is a wrapper over [Requests](http://docs.python-requests.org/en/master/).
All http methods will be supported soon.


## Requirements

* Python 2.7
* boto3
* pip
* AWS account
* awscli (configured)

**LambdaCron** is based 100% on AWS cloud.

## Frequency

#### Execution time
Expand All @@ -383,8 +372,20 @@ You can read in following [documentation](http://docs.aws.amazon.com/AmazonCloud

Be aware of this.

# Requirements

* Python 2.7
* boto3
* pip
* AWS account
* awscli (configured)

**LambdaCron** is based 100% on AWS cloud.

## Getting Started

**Important!** The tool is not available in **pip** yet. If you want to try it, check [Development](#development)

### Install

``` bash
Expand Down Expand Up @@ -416,11 +417,24 @@ or for each command:
$ lambda-cron create --help
```

## Development

To start working with **LambdaCron** you should clone the project, create a
virtualenv (optional) and install dependencies:

``` bash
$ git clone https://github.com/MediaMath/lambda-cron.git
$ cd lambda-cron
$ virtualenv venv
$ source venv/bin/activate
$ pip install -r requirements-dev.txt
$ ./lambda_cron/lambda-cron --help
```

## TODO & CONTRIBUTING
## Contributing

In [TODO](./TODO.md) there is a list of features/improvements that
would be good to have in **LambdaCron**.
Contributions are welcome. You can find open issues with some features and
improvements that would be good to have in **LambdaCron**.

Before contribute we encourage to take a look of following
[tips provided by GitHub](https://guides.github.com/activities/contributing-to-open-source/)
91 changes: 0 additions & 91 deletions TODO.md

This file was deleted.