Skip to content

Commit

Permalink
Make it clearer that extensions can only be installed during initial …
Browse files Browse the repository at this point in the history
…setup (#83)
  • Loading branch information
Pabl0cks committed Sep 13, 2024
1 parent f29fa81 commit f927d55
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 5 deletions.
4 changes: 4 additions & 0 deletions docs/extensions/availableExtensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@ sidebar_position: 10

# Available Extensions

:::info Info
Extensions can only be installed during the initial setup of a new Scaffold-ETH 2 project.
:::info Info

## Core Extensions

Core extensions are extensions built and maintained by Scaffold-ETH 2 team. These extensions can be directly accessed via just extension name without mentioning the github user name and branch name:
Expand Down
16 changes: 11 additions & 5 deletions docs/extensions/extensions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,27 @@ sidebar_position: 9

# 🔌 Extensions

This guide introduces extensions for Scaffold-ETH 2 and explains how to use and create extensions.
This guide introduces extensions for Scaffold-ETH 2 and explains how to install and create them.

## What are Extensions?

Extensions are modular add-ons for Scaffold-ETH 2 that provide additional functionality or serve as examples for specific features. They offer several benefits:
Extensions are modular add-ons for Scaffold-ETH 2 that provide additional functionality or serve as examples for specific features.

:::info Info
Extensions can only be installed during the initial setup of a new Scaffold-ETH 2 project.
:::info Info

They offer several benefits:

- Seamless integration with the base Scaffold-ETH 2 project
- Quick addition of new features, pages, contracts, or components
- Quick addition of new features, pages, contracts, or components at project creation
- Compatibility with Scaffold-ETH 2 core updates and improvements

Extensions are compact packages containing specific code (such as a smart contract or UI component) that automatically integrate with the latest version of Scaffold-ETH 2 when initializing a new project via npx. They are starting points for your project, not finished products.

## Using Extensions
## Installing Extensions

To use an extension when creating a new Scaffold-ETH 2 project, run:
To install an extension when creating a new Scaffold-ETH 2 project, run:

```bash
npx create-eth@latest -e {github-username}/{extension-repo-name}:{branch-name}
Expand Down

0 comments on commit f927d55

Please sign in to comment.