Skip to content

Commit 1d892a3

Browse files
authored
Add direct template commands and clarify OTP requirements (#18)
- Document rebar3 new commands for direct template generation - Add examples for all three templates (hello_world, presence, frontend) - Organize usage into Interactive CLI vs Direct Commands options - Clarify OTP 27+ for templates, OTP 28+ for interactive CLI - Update rebar.config minimum_otp_vsn to 27 for broader compatibility
1 parent 6cdb060 commit 1d892a3

File tree

2 files changed

+20
-2
lines changed

2 files changed

+20
-2
lines changed

README.md

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ Add to your project's `rebar.config`:
2727

2828
## Usage
2929

30+
### Option 1: Interactive CLI
31+
3032
Run the interactive menu:
3133

3234
```bash
@@ -75,6 +77,21 @@ The interactive flow:
7577
- **Presence** - Real-time app with PubSub Presence integration
7678
- **Frontend** - Modern web app with Tailwind CSS and ESBuild
7779
80+
### Option 2: Direct Template Commands
81+
82+
You can also create projects directly using rebar3's new command:
83+
84+
```bash
85+
# Create a basic Arizona application
86+
$ rebar3 new arizona.hello_world my_app
87+
88+
# Create a real-time application with presence
89+
$ rebar3 new arizona.presence my_chat_app
90+
91+
# Create a modern frontend application
92+
$ rebar3 new arizona.frontend my_web_app
93+
```
94+
7895
## Templates
7996
8097
### Frontend Template
@@ -156,7 +173,8 @@ $ rebar3 ci
156173
157174
## Requirements
158175
159-
- Erlang/OTP 28+
176+
- **Erlang/OTP 27+** - For template generation (`rebar3 new arizona.*`)
177+
- **Erlang/OTP 28+** - Required for interactive CLI (`rebar3 arizona`)
160178
161179
## License
162180

rebar.config

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{minimum_otp_vsn, "28"}.
1+
{minimum_otp_vsn, "27"}.
22

33
{erl_opts, [
44
debug_info,

0 commit comments

Comments
 (0)