Skip to content

Commit

Permalink
README: Table of contents
Browse files Browse the repository at this point in the history
  • Loading branch information
bcongdon committed Apr 27, 2018
1 parent ee15b6c commit 43703e7
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,14 @@ Please note we have a code of conduct, please follow it in all your interactions
1. Create a PR that has a descriptive name and comprehensive description of the changes made.
1. You may merge the Pull Request in once you receive approval on the PR.

## Updating the README

The corral README uses [doctoc](https://github.com/thlorenz/doctoc) to generate the table of contents. If you change the heading structure of the README, please rerun doctoc:

```
doctoc README.md --github
```

## Code of Conduct

### Our Pledge
Expand Down
31 changes: 31 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,35 @@ but corral is modular enough that support for other serverless platforms can be

Corral is best suited for data-intensive but computationally inexpensive tasks, such as ETL jobs.


**Contents:**
---
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->


- [Examples](#examples)
- [Deploying in Lambda](#deploying-in-lambda)
- [AWS Credentials](#aws-credentials)
- [Configuration](#configuration)
- [Configuration Settings](#configuration-settings)
- [Framework Settings](#framework-settings)
- [Lambda Settings](#lambda-settings)
- [Command Line Flags](#command-line-flags)
- [Environment Variables](#environment-variables)
- [Config Files](#config-files)
- [Architecture](#architecture)
- [Input Files / Splits](#input-files--splits)
- [Mappers](#mappers)
- [Partition / Shuffle](#partition--shuffle)
- [Reducers / Output](#reducers--output)
- [Contributing](#contributing)
- [Running Tests](#running-tests)
- [License](#license)
- [Previous Work / Attributions](#previous-work--attributions)

<!-- END doctoc generated TOC please keep comment here to allow auto update -->

## Examples

Every good MapReduce framework needs a WordCount™ example. Here's how to write a "word count" in corral:
Expand Down Expand Up @@ -214,4 +243,6 @@ This project is licensed under the MIT License - see the [LICENSE](LICENSE) file
- Excellent Python library for writing MapReduce jobs for Hadoop, EMR/Dataproc, and others
- [dmrgo](https://github.com/dgryski/dmrgo)
- mrjob-inspired Go MapReduce library
- [Zappa](https://github.com/Miserlou/Zappa)
- Serverless Python toolkit. Inspired much of the way that corral does automatic Lambda deployment
- Logo: [Fence by Vitaliy Gorbachev from the Noun Project](https://thenounproject.com/search/?q=fence&i=1291185)

0 comments on commit 43703e7

Please sign in to comment.