From 16db170b2c6d18c1da2244d91f10d7c2f5363ad8 Mon Sep 17 00:00:00 2001
From: Eric Gustin <34000337+EricGustin@users.noreply.github.com>
Date: Fri, 7 Mar 2025 18:38:14 -0800
Subject: [PATCH] Update arcade new (#266)
* New README
---
.../templates/{{ toolkit_name }}/README.md | 100 ++++++------------
1 file changed, 33 insertions(+), 67 deletions(-)
diff --git a/arcade/arcade/templates/{{ toolkit_name }}/README.md b/arcade/arcade/templates/{{ toolkit_name }}/README.md
index 9dc7a6ef..2eaf32d4 100644
--- a/arcade/arcade/templates/{{ toolkit_name }}/README.md
+++ b/arcade/arcade/templates/{{ toolkit_name }}/README.md
@@ -1,74 +1,40 @@
-# {{ toolkit_name }}
+
+

+
+
+
+
+
+
+
+
+# Arcade {{ toolkit_name }} Toolkit
{{ toolkit_description }}
-## Creating your new toolkit repo
+## Features
-1. Run `arcade new` and answer all the questions
-2. Navigate to your new toolkit directory:
- ```bash
- cd {{ toolkit_name }}
- ```
-3. Initialize git repository:
- ```bash
- git init
- ```
-4. Create a new repository in Github with the same name as your new toolkit
- > Note: Don't create a README, LICENSE or .gitignore when creating the repository because `arcade new` has already created these files for you.
-5. Add remote and push your code:
- ```bash
- git remote add origin https://github.com/{{ toolkit_author_name }}/{{ toolkit_name }}.git
- git branch -M main
- git add .
- git commit -m "Initial commit"
- git push -u origin main
- ```
+- The {{ toolkit_name }} toolkit does not have any features yet.
-## Publishing to PyPi
+## Install
-### Generating a PyPi API Key
-
-1. Log into your PyPi account
-2. Navigate to your Account settings and add an API token
-3. Copy the token
-4. In your Github repository:
- - Go to Settings > Secrets and variables > Actions
- - Click "New repository secret"
- - Name your secret `PYPI_TOKEN`
- - Paste your API Token into the Secret field
-
-### Creating a Release
-
-1. Navigate to your Github repository and click on Releases
-2. Create a new tag that corresponds to the version in your toolkit's `pyproject.toml` file
- > Note: This will be 0.0.1 for your first release
-
-## How to install the toolkit:
-1. Run `make install` from the root of the repository
-
-## How to run tests:
-1. Run `make test` from the root of the repository
-
-## How to run evals:
-1. [Install the Arcade Engine Locally](https://docs.arcade.dev/home/install/local)
-2. Install extra dependencies needed for evals:
- ```bash
- pip install 'arcade-ai[evals]'
- ```
-3. Log into Arcade:
- ```bash
- arcade login
- ```
-4. Start the Arcade Engine and Worker:
- ```bash
- arcade dev
- ```
-5. In a separate terminal, navigate to the `evals` directory:
- ```bash
- cd evals
- ```
-5. Run the evals:
- ```bash
- arcade evals --host localhost --details
- ```
+Install this toolkit using pip:
+```bash
+pip install {{ package_name }}
+```