Skip to content

Commit

Permalink
Small doc adjustments (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
traut authored Feb 16, 2024
1 parent 924170e commit 6eb511b
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 15 deletions.
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Codifying and automating mission-critical communications with standardized and r
> [!NOTE]
> Fabric is currently in the early stages of development, and there may be some issues. If you have any suggestions, ideas, or encounter bugs, please share them in [Fabric Community slack](https://fabric-community.slack.com/).
Fabric is an open-source CLI tool and a configuration language that codifies and automation of the content generation process.
Fabric is an open-source CLI tool and a configuration language that codifies and automates content generation.

<div align="center">
<img src=".assets/diagram.svg" alt="The diagram shows a sketch of a Fabric template and rendered document" width="600px"/>
Expand All @@ -32,22 +32,19 @@ See [Documentation](https://blackstork.io/fabric/docs/) for more details on the

To get started with Fabric, follow these simple steps for installation across various operating systems:

- **download release archives**: choose and download the appropriate release for your operating system (Windows, macOS, or Linux) and architecture (32-bit or 64-bit) in ["Releases" section](https://github.com/blackstork-io/fabric/releases);
- **unpack the archives**: extract the contents of the downloaded archive to a preferred directory;
- **run the binary**: run `fabric` binary from the command line to launch Fabric.
- **download release archives**: choose and download the appropriate release for your operating system (Windows, macOS/Darwin, or Linux) and architecture in ["Releases" section](https://github.com/blackstork-io/fabric/releases);
- **unpack the archives**: extract the contents of the downloaded archives to a preferred directory;

That's it! You're now ready to use Fabric. For more details on usage and configuration options, refer to the "Usage" paragraph below or [Fabric CLI](https://blackstork.io/fabric/docs/cli) documentation.



# Usage

The command line interface to Fabric is `fabric` CLI tool. It supports two sub-commands:

- `fabric data` — executes the data block and prints out prettified JSON to standard output.
- `fabric render` — renders the specified target (a document template) into Markdown and outputs the result to standard output or to a file.
- `data` — executes the data block and prints out prettified JSON to standard output.
- `render` — renders the specified target (a document template) into Markdown and outputs the result to standard output or to a file.

```bash
```text
$ fabric --help
Usage:
Expand Down Expand Up @@ -76,13 +73,15 @@ Use "fabric [command] --help" for more information about a command.

Fabric loads `*.fabric` files from a source directory. By default, the current directory (`.`) is a source directory. If you wish to specify a different location, use `--source-dir` argument when running `fabric`.

You can find a collection of free Fabric templates in [Fabric Templates](https://github.com/blackstork-io/fabric-templates) repository.

# Documentation

Visit [https://blackstork.io/fabric/docs/](https://blackstork.io/fabric/docs/) for full documentation.

# Security

Please report any suspected security vulnerabilities through GitHub's [security advisory reporting](https://github.com/blackstork-io/fabric/security/advisories/new). We take all legitimate reports seriously and will thoroughly investigate.
Please report any suspected security vulnerabilities through GitHub's [security advisory reporting](https://github.com/blackstork-io/fabric/security/advisories/new). We treat every report with utmost seriousness and will conduct a comprehensive investigation.

We kindly request that you talk to us before making any public disclosures. This ensures that no excessive information is revealed before a patch is ready and users have enough time to upgrade.

Expand Down
8 changes: 3 additions & 5 deletions docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,12 @@ The archives of compiled binaries for Fabric are available for Windows, macOS, a
To get started with Fabric:

- **download release archives**: choose and download the appropriate release for your operating system (Windows, macOS/Darwin, or Linux) and architecture in ["Releases" section](https://github.com/blackstork-io/fabric/releases);
- **unpack the archives**: extract the contents of the downloaded archive to a preferred directory;
- **unpack the archives**: extract the contents of the downloaded archives to a preferred directory;

For example, on macOS you can do:
For example, for the macOS you can do:

```bash
wget https://github.com/blackstork-io/fabric/releases/download/v0.3.0/vale_0.3.0_Linux_64-bit.tar.gz
mkdir fabric && tar -xvzf vale_2.28.0_Linux_64-bit.tar.gz -C bin
export PATH=./bin:"$PATH"
TBD
```

That's it! You're now ready to use Fabric. For more details on usage and configuration options, refer [Fabric CLI]({{< ref "cli.md" >}}) documentation.

0 comments on commit 6eb511b

Please sign in to comment.