Skip to content

Commit

Permalink
Add messages.json and setup instructions for after installation
Browse files Browse the repository at this point in the history
  • Loading branch information
Bill Patrianakos committed Jan 10, 2013
1 parent b5e67cf commit 08d0680
Show file tree
Hide file tree
Showing 6 changed files with 51 additions and 4 deletions.
3 changes: 3 additions & 0 deletions .gitignore
@@ -0,0 +1,3 @@
# Ignore these files!

Writeapp.pyc
8 changes: 5 additions & 3 deletions README.md
Expand Up @@ -21,7 +21,9 @@ __Coming Soon__
__Can't find the folder?__

Windows: `%APPDATA%\Sublime Text 2`

Mac: ~/Library/Application Support/Sublime Text 2

Linux: ~/.config/sublime-text-2

### Via Git
Expand All @@ -39,8 +41,8 @@ __Setup__
Before you can use the plugin you have to add your username and password to your User settings file. Add the following lines to the JSON that may already be there:

```
"writeapper_user": "bill",
"writeapp_pass": "ih8ny1"
"writeapper_user": "yourUsername",
"writeapp_pass": "yourPassword"
```

If your User Settings file is empty, use this code instead:
Expand Down Expand Up @@ -83,4 +85,4 @@ __Accepted YAML Front Matter Settings__

*public*: Boolean. Accepts values "true" or "false". Defaults to "false" if empty or missing. Anything other than "true" or "false" results in the app turning it into a FALSE.

More settings to come.
More settings to come.
1 change: 0 additions & 1 deletion Writeapp.py
@@ -1,7 +1,6 @@
import sublime, sublime_plugin, subprocess, thread, os, urllib, urllib2, httplib
# import sublime, sublime_plugin, subprocess, thread, os, functools, glob, fnmatch


class WriteappCommand(sublime_plugin.TextCommand):
def run(self, edit):
# Get settings
Expand Down
Binary file removed Writeapp.pyc
Binary file not shown.
3 changes: 3 additions & 0 deletions messages.json
@@ -0,0 +1,3 @@
{
"install": "messages/install.txt",
}
40 changes: 40 additions & 0 deletions messages/install.txt
@@ -0,0 +1,40 @@
# Thanks for installing Write.app for Sublime Text!
===================================================

*Before you get started, be sure to edit your settings or the plugin will not work*

## Setup
===================================================

1. Go to 'Preferences > Settings - User'

2. In your settings file add the following lines to the list of settings already present:

"writeapper_user": "yourUsername",
"writeapp_pass": "yourPassword"

Just replace the relevant parts with your username and your password and you're ready to go!

## Usage
===================================================

To save your file to your Write.app account press 'alt+s' or right click anywhere inside the
text you are editing and choose "Save to Write.app".

To tell Write.app to add a title to your note or make your note public add the proper
YAML front matter at the first line of your file. The following is an example of how this works:

---
title: My Great Note
public: true
---
Note content goes here



Please see http://github.com/WrtApp/Writeapp for more details on setup and usage.

IMPORTANT NOTE:
This version of the plugin can only save notes to Write.app that have already been saved
on your computer. Future releases will have the ability to send notes to Write.app from
saved or unsaved files.

0 comments on commit 08d0680

Please sign in to comment.