Skip to content

Commit 96034ec

Browse files
fsargentjavibravo
authored andcommitted
Create README.md (#26)
1 parent 96fd476 commit 96034ec

File tree

1 file changed

+13
-15
lines changed

1 file changed

+13
-15
lines changed

README.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,21 @@
44
![LambdaCron](./lambda-cron-diagram.png "LambdaCron")
55

66
**LambdaCron** is a serverless cron tool. It provides a way to run scheduled tasks
7-
on the AWS cloud, tasks defined in YAML and all managed by a command line tool
7+
on the AWS cloud defined in YAML and managed by a command line tool
88
([LambdaCron CLI](#lambdacron-cli)). Tasks are scheduled using the same syntax for
99
expressions as Linux [crontab](https://help.ubuntu.com/community/CronHowto).
1010

1111
Traditionally, to run scheduled tasks you need set up cron jobs in the server where
12-
you want them to run. Nonetheless this doesn't make sense anymore when building a
12+
you want them to run. This doesn't make sense when building a
1313
serverless architecture, where servers are transparent to users. In order to solve this
14-
AWS provide [CloudWatch Events](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html),
15-
which allow you to run scheduled events (called rules) to invoke some others AWS services in
16-
a cron-like way. It is useful tool but it is detached from the traditional way to manage
17-
and run cron jobs and it has some [limitations](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/cloudwatch_limits_cwe.html)
14+
AWS provides [CloudWatch Events](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/WhatIsCloudWatchEvents.html),
15+
which allow you to run scheduled events (called rules) to invoke AWS services in
16+
a cron-like way. While it is a useful tool, it is very different from the traditional way to manage
17+
and run cron jobs and it has some serious [limitations](http://docs.aws.amazon.com/AmazonCloudWatch/latest/events/cloudwatch_limits_cwe.html).
1818

19-
LambdaCron is trying to fill in the gap providing a tool to define cron jobs in a
20-
user friendly manner and manage them how developers are used to. With LambdaCron you
21-
define each of your tasks in an independent YAML file including the cron expression.
22-
Once you tasks are defined you will manage them using a command line tool, from your
23-
terminal without the need to access to the AWS console.
19+
LambdaCron fills in the gap by providing a user friendly way to manage serverless cron jobs just like cron.
20+
With LambdaCron you define each of your tasks in an independent YAML file.
21+
Once you tasks are defined you can manage them using the command line tool without the need to access to the AWS console.
2422

2523
LambdaCron offers 4 different types of tasks:
2624

@@ -29,8 +27,8 @@ LambdaCron offers 4 different types of tasks:
2927
* **Batch task**: submit AWS Batch job.
3028
* **HTTP task**: send HTTP requests (GET & POST).
3129

32-
Currently it provides as target 3 AWS services and HTTP requests, but what is most
33-
important is that it is ready be extended for other services and, in general, it is
30+
Currently LambdaCron intergrates with HTTP requests and 3 AWS services.
31+
It is ready be extended for other services and, in general, it is
3432
ready to reach any service available by an API.
3533

3634
## LambdaCron CLI
@@ -47,7 +45,7 @@ There are 3 levels of preferences for settings:
4745

4846
* Environment: Custom values for an specific environment.
4947
* Global: Custom values that will have effect to all environments created.
50-
* Default: Default values in case no custom values are specified (by environment or globally)
48+
* Default: Default values, in case no custom values are specified (by environment or globally)
5149

5250
Highest level of preference is *Environment*, followed by *Global* and finally *Default*. Each option
5351
in the settings can set the value from different levels. Higher level of preference overwrite lower levels.
@@ -452,5 +450,5 @@ $ ./lambda_cron/lambda-cron --help
452450
Contributions are welcome. You can find open issues with some features and
453451
improvements that would be good to have in **LambdaCron**.
454452

455-
Before contribute we encourage to take a look of following
453+
Before contribute we encourage to take a look at the following
456454
[tips provided by GitHub](https://guides.github.com/activities/contributing-to-open-source/)

0 commit comments

Comments
 (0)