Skip to content

Commit

Permalink
Update README.md with latest format
Browse files Browse the repository at this point in the history
  • Loading branch information
khushboo9024 committed Dec 13, 2023
1 parent 7bd74b4 commit d39b595
Showing 1 changed file with 52 additions and 32 deletions.
84 changes: 52 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Pipes pipeline library for [Flowpipe](https://flowpipe.io), enabling seamless in

## Getting Started

### Requirements

Docker daemon must be installed and running. Please see [Install Docker Engine](https://docs.docker.com/engine/install/) for more information.

### Installation

Download and install Flowpipe (https://flowpipe.io/downloads). Or use Brew:
Expand All @@ -21,13 +17,6 @@ brew tap turbot/tap
brew install flowpipe
```

Clone:

```sh
git clone https://github.com/turbot/flowpipe-mod-pipes.git
cd flowpipe-mod-pipes
```

### Credentials

By default, the following environment variables will be used for authentication:
Expand All @@ -50,51 +39,82 @@ For more information on credentials in Flowpipe, please see [Managing Credential

### Usage

List pipelines:
[Initialize a mod](https://flowpipe.io/docs/build/index#initializing-a-mod):

```sh
flowpipe pipeline list
mkdir my_mod
cd my_mod
flowpipe mod init
```

Run a pipeline:
[Install the Pipes mod](https://flowpipe.io/docs/build/mod-dependencies#mod-dependencies) as a dependency:

```sh
flowpipe pipeline run get_user --arg user_handle='turbot'
flowpipe mod install github.com/turbot/flowpipe-mod-pipes
```

You can pass in pipeline arguments as well:
[Use the dependency](https://flowpipe.io/docs/build/write-pipelines/index) in a pipeline step:

```sh
flowpipe pipeline run get_organization_member --arg user_handle='turbot' --arg org_handle='turbot'
vi my_pipeline.fp
```

To use a specific `credential`, specify the `cred` pipeline argument:
```hcl
pipeline "my_pipeline" {
step "pipeline" "list_organization_members" {
pipeline = pipes.pipeline.list_organization_members
args = {
org_handle = "acme-demo"
}
}
}
```

[Run the pipeline](https://flowpipe.io/docs/run/pipelines):

```sh
flowpipe pipeline run my_pipeline
```

### Developing

Clone:

```sh
flowpipe pipeline run get_user --arg user_handle='turbot' --arg cred=my_pipes
git clone https://github.com/turbot/flowpipe-mod-pipes.git
cd flowpipe-mod-pipes
```

For more examples on how you can run pipelines, please see [Run Pipelines](https://flowpipe.io/docs/run/pipelines).
List pipelines:

### Configuration
```sh
flowpipe pipeline list
```

No additional configuration is required.
Run a pipeline:

## Contributing
```sh
flowpipe pipeline run get_user --arg user_handle=turbot
```

If you have an idea for additional pipelines or just want to help maintain and extend this mod ([or others](https://github.com/topics/flowpipe-mod)) we would love you to join the community and start contributing.
To use a specific `credential`, specify the `cred` pipeline argument:

- **[Join #flowpipe in our Slack community](https://flowpipe.io/community/join)**
```sh
flowpipe pipeline run get_user --arg user_handle=turbot --arg cred=pipes_profile
```

Please see the [contribution guidelines](https://github.com/turbot/flowpipe/blob/main/CONTRIBUTING.md) and our [code of conduct](https://github.com/turbot/flowpipe/blob/main/CODE_OF_CONDUCT.md).
## Open Source & Contributing

Want to help but not sure where to start? Pick up one of the `help wanted` issues:
This repository is published under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0). Please see our [code of conduct](https://github.com/turbot/.github/blob/main/CODE_OF_CONDUCT.md). We look forward to collaborating with you!

- [Flowpipe](https://github.com/turbot/flowpipe/labels/help%20wanted)
- [Pipes Mod](https://github.com/turbot/flowpipe-mod-pipes/labels/help%20wanted)
[Flowpipe](https://flowpipe.io) is a product produced from this open source software, exclusively by [Turbot HQ, Inc](https://turbot.com). It is distributed under our commercial terms. Others are allowed to make their own distribution of the software, but cannot use any of the Turbot trademarks, cloud services, etc. You can learn more in our [Open Source FAQ](https://turbot.com/open-source).

## Get Involved

## License
**[Join #flowpipe on Slack →](https://flowpipe.io/community/join)**

This mod is licensed under the [Apache License 2.0](https://github.com/turbot/flowpipe-mod-pipes/blob/main/LICENSE).
Want to help but not sure where to start? Pick up one of the `help wanted` issues:

Flowpipe is licensed under the [AGPLv3](https://github.com/turbot/flowpipe/blob/main/LICENSE).
- [Flowpipe](https://github.com/turbot/flowpipe/labels/help%20wanted)
- [Pipes Mod](https://github.com/turbot/flowpipe-mod-pipes/labels/help%20wanted)

0 comments on commit d39b595

Please sign in to comment.