Skip to content

Commit

Permalink
Update README.md as per latest standard (#2)
Browse files Browse the repository at this point in the history
  • Loading branch information
khushboo9024 authored Dec 13, 2023
1 parent 1e80985 commit f37ce23
Showing 1 changed file with 46 additions and 21 deletions.
67 changes: 46 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,6 @@ Ipstack pipeline library for [Flowpipe](https://flowpipe.io) enabling seamless i

## 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,12 +17,6 @@ brew tap turbot/tap
brew install flowpipe
```

Clone:

```sh
git clone https://github.com/turbot/flowpipe-mod-ipstack.git
cd flowpipe-mod-ipstack
```
### Credentials

By default, the following environment variables will be used for authentication:
Expand All @@ -49,35 +39,70 @@ 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 Ipstack mod](https://flowpipe.io/docs/build/mod-dependencies#mod-dependencies) as a dependency:

```sh
flowpipe pipeline run lookup_ip_address --arg ip_address='76.76.21.21'
flowpipe mod install github.com/turbot/flowpipe-mod-ipstack
```

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 lookup_ip_address --arg ip_address='76.76.21.21' --arg output_type='xml'
vi my_pipeline.fp
```

To use a specific `credential`, specify the `cred` pipeline argument:
```hcl
pipeline "my_pipeline" {
step "pipeline" "lookup_ip_address" {
pipeline = ipstack.pipeline.lookup_ip_address
args = {
ip_address = "76.76.21.21"
}
}
}
```

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

```sh
flowpipe pipeline run lookup_ip_address --arg ip_address='76.76.21.21' --arg cred=ipstack_api_key
flowpipe pipeline run my_pipeline
```

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

### Configuration
Clone:

No additional configuration is required.
```sh
git clone https://github.com/turbot/flowpipe-mod-ipstack.git
cd flowpipe-mod-ipstack
```

List pipelines:

```sh
flowpipe pipeline list
```

Run a pipeline:

```sh
flowpipe pipeline run lookup_ip_address --arg ip_address='76.76.21.21'
```

To use a specific `credential`, specify the `cred` pipeline argument:

```sh
flowpipe pipeline run lookup_ip_address --arg ip_address='76.76.21.21' --arg cred=ipstack_api_key
```

## Open Source & Contributing

Expand Down

0 comments on commit f37ce23

Please sign in to comment.