Solidity Docstring Generator
============================

[Sublime Text](http://www.sublimetext.com/) plugin to automatically generate Docstrings for Solidity smart contracts.

Solidity Docstring Generator allows you to do this:

![Gif of usage](https://i.imgur.com/FRNyJwh.gif)

Installation
------------

__Package Control (recommended)__

- Open the command palette is Sulbime (Command+Shift+P on Mac, Ctrl+Shift+P on Linux/Windows)
- Use the "Package Control: Install Package" command and search for "Solidity Docstring Generator

__Manually__

Add `SolidityDocString.py` and `SolidityDocstringGenerator.sublime-commands` to your Packages directory.

(OSX): `Users\”Username”\Library\Application Support\Sublime Text 3\Packages`
(WIN7): `C:\Users\”Username”\AppData\Roaming\Sublime Text 3\Packages`

Usage
-----

Use the `Generate Solidity Docstrings` command through the command palette (Command+Shift+P on Mac, Ctrl+Shift+P on Linux/Windows).