Skip to content

Commit

Permalink
Merge pull request #44 from sectore/fix/readme-quick-start
Browse files Browse the repository at this point in the history
fix(readme): add a missing step to run GraphQL queries successfully
  • Loading branch information
tsirysndr authored Jan 30, 2025
2 parents 7d562b3 + 4e2ac1e commit 2140ede
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ FluentCI Engine is a programmable CI/CD engine (used by [FluentCI](https://githu

> [!NOTE]
> **Project Status: 🐲 Unstable, alpha-ish quality.**
> This project is still in the early stages of development,
> and it is not yet ready for production use.
> This project is still in the early stages of development,
> and it is not yet ready for production use.
> It is not feature-complete, and it is not yet stable. Use at your own risk.
![Cover](https://github.com/fluentci-io/fluentci-engine/raw/HEAD/.github/assets/api.png)
Expand Down Expand Up @@ -49,6 +49,7 @@ git clone https://github.com/fluentci-io/fluentci-engine.git
cd fluentci-engine
# Install dependencies
nix develop
cd ./fixtures
cargo run -p fluentci-engine -- serve
# Open the browser and go to http://localhost:6880/graphiql
# See ./fixtures for some GraphQL queries examples
Expand Down Expand Up @@ -183,7 +184,7 @@ fluentci-engine call -m ./target/wasm32-unknown-unknown/release/nix.wasm -- exec
- [terraform](https://github.com/fluent-ci-templates/terraform-pipeline/tree/main/plugin)
- [zig](https://github.com/fluent-ci-templates/zig-pipeline/tree/main/plugin)
- [wasmer](https://github.com/fluent-ci-templates/wasmer-pipeline/tree/main/plugin)

### 🌈 Builtin functions

FluentCI Plugin Development Kit ([fluentci_pdk](https://docs.rs/fluentci-pdk/latest/fluentci_pdk)) provides some builtin functions from that you can use in your plugins:
Expand Down Expand Up @@ -379,7 +380,7 @@ jobs:
uses: fluentci-io/setup-fluentci@v5
with:
wasm: true # set to true so WebAssembly plugins can be used
plugin: base # Name of the Wasm Plugin to use without the .wasm extension,
plugin: base # Name of the Wasm Plugin to use without the .wasm extension,
# will be downloaded from the registry https://pkg.fluentci.io

# Arguments to pass to the plugin: function_name args
Expand Down

0 comments on commit 2140ede

Please sign in to comment.