v1.0.1

README.md

@@ -6,87 +6,15 @@
 - Un-zip
 - Double-click on rename-master-symbol.sketchplugin
 
-## Development Guide
+## Features
 
-_This plugin was created using `skpm`. For a detailed explanation on how things work, checkout the [skpm Readme](https://github.com/skpm/skpm/blob/master/README.md)._
+- Rename and organize your symbols by selecting one or many at a time.
+- Dynamically detect the structure of the name of the symbols.
+- Use “/“ to organize your symbols.
+- Dynamically detect the structure of the name of the symbols.
+- Add or remove levels massively in your symbols without affecting the final name.
+- Format your symbols automatically.
+- Use the shortcut "cmd + ctrl + r" to run the pluguin.
 
-### Usage
+![Example of Symbol Master Renamer in Sketch](https://github.com/miguelangelnarvaezgo/symbol-master-renamer/blob/master/sketch-assets/example.png)
 
-Install the dependencies
-
-```bash
-npm install
-```
-
-Once the installation is done, you can run some commands inside the project folder:
-
-```bash
-npm run build
-```
-
-To watch for changes:
-
-```bash
-npm run watch
-```
-
-Additionally, if you wish to run the plugin every time it is built:
-
-```bash
-npm run start
-```
-
-### Custom Configuration
-
-#### Babel
-
-To customize Babel, you have two options:
-
-- You may create a [`.babelrc`](https://babeljs.io/docs/usage/babelrc) file in your project's root directory. Any settings you define here will overwrite matching config-keys within skpm preset. For example, if you pass a "presets" object, it will replace & reset all Babel presets that skpm defaults to.
-
-- If you'd like to modify or add to the existing Babel config, you must use a `webpack.skpm.config.js` file. Visit the [Webpack](#webpack) section for more info.
-
-#### Webpack
-
-To customize webpack create `webpack.skpm.config.js` file which exports function that will change webpack's config.
-
-```js
-/**
- * Function that mutates original webpack config.
- * Supports asynchronous changes when promise is returned.
- *
- * @param {object} config - original webpack config.
- * @param {boolean} isPluginCommand - whether the config is for a plugin command or a resource
- **/
-module.exports = function(config, isPluginCommand) {
-  /** you can change config here **/
-}
-```
-
-### Debugging
-
-To view the output of your `console.log`, you have a few different options:
-
-- Use the [`sketch-dev-tools`](https://github.com/skpm/sketch-dev-tools)
-- Run `skpm log` in your Terminal, with the optional `-f` argument (`skpm log -f`) which causes `skpm log` to not stop when the end of logs is reached, but rather to wait for additional data to be appended to the input
-
-### Publishing your plugin
-
-```bash
-skpm publish <bump>
-```
-
-(where `bump` can be `patch`, `minor` or `major`)
-
-`skpm publish` will create a new release on your GitHub repository and create an appcast file in order for Sketch users to be notified of the update.
-
-You will need to specify a `repository` in the `package.json`:
-
-```diff
-...
-+ "repository" : {
-+   "type": "git",
-+   "url": "git+https://github.com/ORG/NAME.git"
-+  }
-...
-```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "symbol-master-renamer",
-  "description": "",
+  "description": "Very simple plugin to help in the task of renaming and organizing the master symbols in a sketch project.",
   "version": "1.0.0",
   "engines": {
     "sketch": ">=49.0"