<commit_before># grunt-wp-readme

Generate a readme.txt for your WordPress plugins.

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-wp-readme --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-wp-readme');
```

## The "wp_readme" task

### Overview
In your project's Gruntfile, add a section named `wp_readme` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  wp_readme: {
    options: {
      readme: 'readme.txt', // This value will be treated as a directory if it doesn't end with readme.txt
      defaultInstallation: '', // The default value of the Installation section if left undefined
      defaultFaq: '', // The default value of the FAQ section if left undefined
      defaultChangelog: '', // The default value of the Changelog section if left undefined
      defaultUpgrade: '', // The default value of the Upgrade Notice section if left undefined
      defaultScreenshots: '' //  The default value of the Screenshots section if left undefined
    },
    your_target: {
      displayName: 'Your Plugin Display Name',
      contributors: ['JohnPBloch'], // An array of wordpress.org usernames
      donateLink: '', // Optional. URL for donations
      tags: [], // An array of tags to help people find your plugin
      minimumVersion: '3.5', // The minimum supported version of WordPress that your plugin works with
      testedUpTo: '3.8', // The version of WordPress up to which you've verified that your plugin works
      stableTag: '1.0.2', // The current stable version of your plugin
      license: 'GPL-2.0+', // License under which your plugin is distributed. Defaults to GPL 2.0+.
      licenseURI: 'http://www.gnu.org/licenses/gpl-2.0.html', // Link to license text
      blurb: '', // A short (preferably one sentence) description of your plugin
      sections: {} // Content for the various sections of the readme
    },
  },
});
```<commit_msg>Add overviews of all the different sections that can be added<commit_after># grunt-wp-readme

Generate a readme.txt for your WordPress plugins.

## Getting Started
This plugin requires Grunt `~0.4.1`

If you haven't used [Grunt](http://gruntjs.com/) before, be sure to check out the [Getting Started](http://gruntjs.com/getting-started) guide, as it explains how to create a [Gruntfile](http://gruntjs.com/sample-gruntfile) as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

```shell
npm install grunt-wp-readme --save-dev
```

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

```js
grunt.loadNpmTasks('grunt-wp-readme');
```

## The "wp_readme" task

### Overview
In your project's Gruntfile, add a section named `wp_readme` to the data object passed into `grunt.initConfig()`.

```js
grunt.initConfig({
  wp_readme: {
    options: {
      readme: 'readme.txt', // This value will be treated as a directory if it doesn't end with readme.txt
      defaultInstallation: '', // The default value of the Installation section if left undefined
      defaultFaq: '', // The default value of the FAQ section if left undefined
      defaultChangelog: '', // The default value of the Changelog section if left undefined
      defaultUpgrade: '', // The default value of the Upgrade Notice section if left undefined
      defaultScreenshots: '' //  The default value of the Screenshots section if left undefined
    },
    your_target: {
      displayName: 'Your Plugin Display Name',
      contributors: ['JohnPBloch'], // An array of wordpress.org usernames
      donateLink: '', // Optional. URL for donations
      tags: [], // An array of tags to help people find your plugin
      minimumVersion: '3.5', // The minimum supported version of WordPress that your plugin works with
      testedUpTo: '3.8', // The version of WordPress up to which you've verified that your plugin works
      stableTag: '1.0.2', // The current stable version of your plugin
      license: 'GPL-2.0+', // License under which your plugin is distributed. Defaults to GPL 2.0+.
      licenseURI: 'http://www.gnu.org/licenses/gpl-2.0.html', // Link to license text
      blurb: '', // A short (preferably one sentence) description of your plugin
      sections: { // Content for the various sections of the readme
        description: '', // String. Longer description of plugin. Defaults to the blurb.
        installation: '', // String or array of instructions.
        faq: [], // Array of faq objects
        screenshots: [], // Array of screenshot captions
        changelog: [], // Array of changelog objects
        upgrade: '', // String. Upgrade notice contents
        extra: {header: false, body: false} // Extra arbitrary section. Optional. May set strings for header and body to define the header (tab) and its contents.
      }
    },
  },
});
```
{'fraction_non_alphanumeric': 0.10253542132736763, 'fraction_numerical': 0.005965697240865026, 'mean_word_length': 3.2885691446842524, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '545527', 'n_tokens_mistral': 1508, 'n_tokens_neox': 1457, 'n_words': 642}