Skip to content

Commit

Permalink
add badge to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
IMax153 committed Sep 19, 2024
1 parent da66d4d commit 5668fae
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
[![Nightly Build](https://github.com/Effect-TS/examples/workflows/Nightly%20Checks/badge.svg)](https://github.com/Effect-TS/examples/actions)

# Effect Examples

## Create Effect App

The easiest way to get started with Effect is by using `create-effect-app`.
The easiest way to get started with Effect is by using `create-effect-app`.

This CLI tool enables you to quickly bootstrap a project with Effect, with everything pre-configured for you.
This CLI tool enables you to quickly bootstrap a project with Effect, with everything pre-configured for you.

You can create a new project using one of our [project templates](./templates) or by using one of the [official Effect examples](./examples).
You can create a new project using one of our [project templates](./templates) or by using one of the [official Effect examples](./examples).

See [the documentation](./packages/create-effect-app/README.md) for more information.

Expand All @@ -22,13 +24,13 @@ The available examples include:

## Templates

This repository contains templates which can be used to quickly bootstrap a new project with Effect via the `create-effect-app` CLI tool.
This repository contains templates which can be used to quickly bootstrap a new project with Effect via the `create-effect-app` CLI tool.

These templates were developed to mirror the project configuration recommneded by the Effect core team and are thus somewhat opinionated.

### Basic

The `basic` template is meant to serve as the foundation for building a single package or library with Effect.
The `basic` template is meant to serve as the foundation for building a single package or library with Effect.

The template features:

Expand All @@ -44,7 +46,7 @@ For more information, see the template [README](./templates/basic/README.md).

### Monorepo

The `monorepo` template is meant to serve as the foundation for building multiple packages or applications with Effect.
The `monorepo` template is meant to serve as the foundation for building multiple packages or applications with Effect.

The template features everything included with the `basic` template in addition to:

Expand All @@ -61,4 +63,3 @@ The template features everything included with the `basic` template, except with
- Pre-configured build pipeline is via [`tsup`](https://github.com/egoist/tsup) to support bundling to a single file

For more information, see the template [README](./templates/cli/README.md).

0 comments on commit 5668fae

Please sign in to comment.