Skip to content

Commit 133a1fd

Browse files
doc: update README.md (#4)
1 parent 4b43c48 commit 133a1fd

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Allie PyFlowKit
1+
# Allie FlowKit Python
22

3-
Welcome to the **Allie PyFlowKit** repository! This repository hosts Python functions similar to the [Allie FlowKit](https://github.com/ansys/allie-flowkit) and serves as a service to expose APIs for each individual external function added to it. These functions can be used to build Allie workflows, enabling a flexible and modular approach to creating and executing workflows with Allie.
3+
Welcome to the **Allie FlowKit Python** repository! This repository hosts Python functions similar to the [Allie FlowKit](https://github.com/ansys/allie-flowkit) and serves as a service to expose APIs for each individual external function added to it. These functions can be used to build Allie workflows, enabling a flexible and modular approach to creating and executing workflows with Allie.
44

55
## Table of Contents
66
- [Introduction](#introduction)
@@ -16,7 +16,7 @@ Welcome to the **Allie PyFlowKit** repository! This repository hosts Python func
1616

1717
## Introduction
1818

19-
**Allie PyFlowKit** is designed to host the code for a Python service that exposes REST APIs for each external function added to it. These functions can be seamlessly integrated into Allie workflows and executed by the Allie Agent, making it easier for teams to customize and extend their workflow capabilities.
19+
**Allie FlowKit Python** is designed to host the code for a Python service that exposes REST APIs for each external function added to it. These functions can be seamlessly integrated into Allie workflows and executed by the Allie Agent, making it easier for teams to customize and extend their workflow capabilities.
2020

2121
## Purpose
2222

@@ -29,9 +29,9 @@ The main purpose of this repository is to:
2929
## How It Works
3030

3131
1. **Function Integration:** External functions are added to this repository and exposed as REST APIs.
32-
2. **Workflow Execution:** Allie workflows can include functions from Allie PyFlowKit.
33-
3. **API Calls:** When an Allie workflow includes a function from Allie PyFlowKit, the Allie Agent calls the function via REST API with the required inputs.
34-
4. **Function Execution:** The function is executed in Allie PyFlowKit, and the output is returned as the body of the REST response.
32+
2. **Workflow Execution:** Allie workflows can include functions from Allie FlowKit Python.
33+
3. **API Calls:** When an Allie workflow includes a function from Allie FlowKit Python, the Allie Agent calls the function via REST API with the required inputs.
34+
4. **Function Execution:** The function is executed in Allie FlowKit Python, and the output is returned as the body of the REST response.
3535

3636
## Getting Started
3737

@@ -45,8 +45,8 @@ The main purpose of this repository is to:
4545

4646
1. Clone the repository:
4747
```sh
48-
git clone https://github.com/allie-pyflowkit.git
49-
cd allie-pyflowkit
48+
git clone https://github.com/allie-flowkit-python.git
49+
cd allie-flowkit-python
5050
```
5151

5252
2. Install the required dependencies:
@@ -125,4 +125,4 @@ We welcome contributions from all teams. To contribute:
125125

126126
---
127127

128-
Thank you for using Allie PyFlowKit! We hope this repository helps you create powerful and flexible Allie workflows. Happy coding!
128+
Thank you for using Allie FlowKit Python! We hope this repository helps you create powerful and flexible Allie workflows. Happy coding!

0 commit comments

Comments
 (0)