Skip to content

Commit f3b4591

Browse files
committed
fix: remove generated readme template
1 parent fb332f4 commit f3b4591

1 file changed

Lines changed: 1 addition & 39 deletions

File tree

README.md

Lines changed: 1 addition & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,48 +1,10 @@
1-
**NOTE: This template for sf plugins is not yet official. Please consult with the Platform CLI team before using this template.**
2-
31
# plugin-app-dev
42

53
[![NPM](https://img.shields.io/npm/v/@salesforce/plugin-app-dev.svg?label=@salesforce/plugin-app-dev)](https://www.npmjs.com/package/@salesforce/plugin-app-dev) [![Downloads/week](https://img.shields.io/npm/dw/@salesforce/plugin-app-dev.svg)](https://npmjs.org/package/@salesforce/plugin-app-dev) [![License](https://img.shields.io/badge/License-Apache--2.0-blue.svg)](https://opensource.org/license/apache-2-0)
64

7-
## Using the template
8-
9-
This repository provides a template for creating a plugin for the Salesforce CLI. To convert this template to a working plugin:
10-
11-
1. Please get in touch with the Platform CLI team. We want to help you develop your plugin.
12-
2. Generate your plugin:
13-
14-
```
15-
sf plugins install dev
16-
sf dev generate plugin
17-
18-
git init -b main
19-
git add . && git commit -m "chore: initial commit"
20-
```
21-
22-
3. Create your plugin's repo in the salesforcecli github org
23-
4. When you're ready, replace the contents of this README with the information you want.
24-
25-
## Learn about `sf` plugins
26-
27-
Salesforce CLI plugins are based on the [oclif plugin framework](https://oclif.io/docs/introduction). Read the [plugin developer guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_cli_plugins.meta/sfdx_cli_plugins/cli_plugins_architecture_sf_cli.htm) to learn about Salesforce CLI plugin development.
28-
29-
This repository contains a lot of additional scripts and tools to help with general Salesforce node development and enforce coding standards. You should familiarize yourself with some of the [node developer packages](#tooling) used by Salesforce. There is also a default circleci config using the [release management orb](https://github.com/forcedotcom/npm-release-management-orb) standards.
30-
31-
Additionally, there are some additional tests that the Salesforce CLI will enforce if this plugin is ever bundled with the CLI. These test are included by default under the `posttest` script and it is required to keep these tests active in your plugin if you plan to have it bundled.
32-
33-
### Tooling
34-
35-
- [@salesforce/core](https://github.com/forcedotcom/sfdx-core)
36-
- [@salesforce/kit](https://github.com/forcedotcom/kit)
37-
- [@salesforce/sf-plugins-core](https://github.com/salesforcecli/sf-plugins-core)
38-
- [@salesforce/ts-types](https://github.com/forcedotcom/ts-types)
39-
- [@salesforce/ts-sinon](https://github.com/forcedotcom/ts-sinon)
40-
- [@salesforce/dev-config](https://github.com/forcedotcom/dev-config)
41-
- [@salesforce/dev-scripts](https://github.com/forcedotcom/dev-scripts)
42-
435
# Salesforce CLI App Dev Plugin
446

45-
A Salesforce CLI plugin for building and deploying web applications that integrate with Salesforce. This plugin provides tools for local development, packaging, and deployment of webapps with built-in Salesforce authentication.
7+
A Salesforce CLI plugin for building web applications that integrate with Salesforce. This plugin provides tools for local development, packaging, and deployment of webapps with built-in Salesforce authentication.
468

479
This plugin is bundled with the [Salesforce CLI](https://developer.salesforce.com/tools/sfdxcli). For more information on the CLI, read the [getting started guide](https://developer.salesforce.com/docs/atlas.en-us.sfdx_setup.meta/sfdx_setup/sfdx_setup_intro.htm).
4810

0 commit comments

Comments
 (0)