<commit_before>#MuraGist

This is a [Mura CMS](http://getmura.com) plugin that enables users to create, manage and display [Gists](https://gist.github.com) within their content.

##Instructions

###Plugin Display Objects
There is one display object available:

#### Display Gist
* Go to the **Edit Content** screen of a content item
* Select the **Layout &amp; Objects** tab
* Select **Plugins** from the Available Content Objects select menu
* Select **MuraGist** from the list of Plugins
* Select **Display Gist** and assign it to your desired display region (e.g., Left Column, Main Content, etc.)
* This should launch the **MuraGist Configurator** window
* Paste/Enter your Gist ID into the Gist ID form field
* Optionally paste/enter your desired Gist filename into the Gist Filename form field. (Some Gists have more than one file associated with it. If you wish to display a specific file, enter the filename, or else all files associated with the Gist will be rendered.)
* Click **Save**
* Then, Publish your content and preview

##Designers / Developers
The 'Plugin Display Objects' may also be added directly onto your template or even dropped into a content region using **[mura]** tags.

###Example Code

####Mura Tag Method
`[mura]$.dspGist(gistID='YourGistID')[/mura]`

####CFML Method
`#$.dspGist(gistID='YourGistID')#`

####Available Attributes

| Attribute 		| Req/Opt 	| Default 			| Description 								|<commit_msg>add installation instructions to README<commit_after>#MuraGist

This is a [Mura CMS](http://getmura.com) plugin that enables users to create, manage and display [Gists](https://gist.github.com) within their content.

##Instructions

###Installation
1. Log in to Github, go to Account Settings, select 'Applications' and create a 'Personal Access Token' and copy the access token
2. Download a .zip of this project from https://github.com/stevewithington/MuraGist/archive/master.zip
3. Log in to Mura CMS as a Super Admin
4. Go to Settings > Plugins
5. Click 'Choose File' and select the .zip file you downloaded from Github
6. Click 'Deploy'
7. Accept the License Agreement
8. Enter your Github Account Username
9. Paste the Personal Access Token you created in step 1 into the Github Personal Access Token field
10. Select which site(s) you wish to enable the plugin for
11. Click 'Update'

###Plugin Display Objects
There is one display object available:

#### Display Gist
* Go to the **Edit Content** screen of a content item
* Select the **Layout &amp; Objects** tab
* Select **Plugins** from the Available Content Objects select menu
* Select **MuraGist** from the list of Plugins
* Select **Display Gist** and assign it to your desired display region (e.g., Left Column, Main Content, etc.)
* This should launch the **MuraGist Configurator** window
* Paste/Enter your Gist ID into the Gist ID form field
* Optionally paste/enter your desired Gist filename into the Gist Filename form field. (Some Gists have more than one file associated with it. If you wish to display a specific file, enter the filename, or else all files associated with the Gist will be rendered.)
* Click **Save**
* Then, Publish your content and preview

##Designers / Developers
The 'Plugin Display Objects' may also be added directly onto your template or even dropped into a content region using **[mura]** tags.

###Example Code

####Mura Tag Method
`[mura]$.dspGist(gistID='YourGistID')[/mura]`

####CFML Method
`#$.dspGist(gistID='YourGistID')#`

####Available Attributes

| Attribute 		| Req/Opt 	| Default 			| Description 								|
{'fraction_non_alphanumeric': 0.09507735583684951, 'fraction_numerical': 0.003938115330520394, 'mean_word_length': 4.608832807570978, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 4, 'https://': 3, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 5, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1609247', 'n_tokens_mistral': 1037, 'n_tokens_neox': 999, 'n_words': 486}