Skip to content

Commit b3a7b81

Browse files
authored
README update (#16)
* Upade README - contributing * Update README - development * Update README - move requirements * update README - fix
1 parent a41fd97 commit b3a7b81

File tree

2 files changed

+28
-105
lines changed

2 files changed

+28
-105
lines changed

README.md

Lines changed: 28 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -350,17 +350,6 @@ task:
350350
It is a wrapper over [Requests](http://docs.python-requests.org/en/master/).
351351
All http methods will be supported soon.
352352
353-
354-
## Requirements
355-
356-
* Python 2.7
357-
* boto3
358-
* pip
359-
* AWS account
360-
* awscli (configured)
361-
362-
**LambdaCron** is based 100% on AWS cloud.
363-
364353
## Frequency
365354
366355
#### Execution time
@@ -383,8 +372,20 @@ You can read in following [documentation](http://docs.aws.amazon.com/AmazonCloud
383372
384373
Be aware of this.
385374
375+
# Requirements
376+
377+
* Python 2.7
378+
* boto3
379+
* pip
380+
* AWS account
381+
* awscli (configured)
382+
383+
**LambdaCron** is based 100% on AWS cloud.
384+
386385
## Getting Started
387386
387+
**Important!** The tool is not available in **pip** yet. If you want to try it, check [Development](#development)
388+
388389
### Install
389390
390391
``` bash
@@ -416,11 +417,24 @@ or for each command:
416417
$ lambda-cron create --help
417418
```
418419

420+
## Development
421+
422+
To start working with **LambdaCron** you should clone the project, create a
423+
virtualenv (optional) and install dependencies:
424+
425+
``` bash
426+
$ git clone https://github.com/MediaMath/lambda-cron.git
427+
$ cd lambda-cron
428+
$ virtualenv venv
429+
$ source venv/bin/activate
430+
$ pip install -r requirements-dev.txt
431+
$ ./lambda_cron/lambda-cron --help
432+
```
419433

420-
## TODO & CONTRIBUTING
434+
## Contributing
421435

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

425439
Before contribute we encourage to take a look of following
426440
[tips provided by GitHub](https://guides.github.com/activities/contributing-to-open-source/)

TODO.md

Lines changed: 0 additions & 91 deletions
This file was deleted.

0 commit comments

Comments
 (0)