Skip to content

docs: add composer create-project as a way to start #41

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
AnuragVasanwala merged 3 commits into from
Oct 1, 2026
Merged

docs: add composer create-project as a way to start #41

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ec7ca45
docs: add composer create-project as a way to start
aryanjasala Oct 1, 2026
fef782c
docs: use a generic folder name in the README command
aryanjasala Oct 1, 2026
d8b6545
docs: let create-project install the dependencies
aryanjasala Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 7 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,13 @@ The skeleton documents what it provides and how to build on it. The framework's

## Get started

Follow [Getting Started](docs/getting-started.md): prerequisites, cloning, installing, naming the plugin, and seeing it running in a local WordPress site. It takes about fifteen minutes.
Create a new plugin with Composer, or clone this repository:

```bash
composer create-project rtcamp/plugin-elementary my-plugin
```

Then follow [Getting Started](docs/getting-started.md): prerequisites, getting the skeleton, installing, naming the plugin, and seeing it running in a local WordPress site. It takes about fifteen minutes.

## What is included

Expand Down
16 changes: 15 additions & 1 deletion docs/getting-started.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,19 @@ An existing local WordPress installation can replace the `wp-env` site; Docker i

## 1. Get the skeleton

Clone it into the folder that will become your plugin directory:
Download it into the folder that will become your plugin directory. Composer gives you a copy without the skeleton's Git history and installs the Composer dependencies:

```bash
composer create-project rtcamp/plugin-elementary acme-content-features
cd acme-content-features
git init
git add .
git commit -m "chore: start from plugin-elementary"
nvm install
nvm use
```

Or clone the repository:

```bash
git clone https://github.com/rtCamp/plugin-elementary.git acme-content-features
Expand All @@ -23,6 +35,8 @@ nvm install
nvm use
```

The first commit gives the Composer copy a baseline to review init's changes against, and the repository lets `npm install` in step 2 set up the Git hooks.

The folder name is the plugin's directory in WordPress and is what you pass to `wp plugin activate`. Name it after the main plugin file init will create (`acme-content-features`), so the local copy matches the release zip.

## 2. Install dependencies
Expand Down
Loading