Browse Source

prepare for publishing

master
Christian Müller 8 years ago
parent
commit
b4716e71f9
  1. 15
      README.md
  2. 5
      assets/public/index.html
  3. 11
      package.json

15
README.md

@ -7,6 +7,17 @@ @@ -7,6 +7,17 @@
Dead simple hosting for markdown notes.
## Installation & Deployment
## Running
TBD
Install `dep` using Homebrew and run it inside project to install the dependencies: `dep ensure`.
Now you can run the app with `make run`.
## Testing
Install `frisby 0.8.5 globally` and link it inside the project:
1. `npm install -g frisby@0.8.5`
2. `npm link frisby`
Now the test can be run with: `make test`

5
assets/public/index.html

@ -29,11 +29,12 @@ @@ -29,11 +29,12 @@
<li><strong>2014-01</strong>: NoteHub API, mobile friendly styling and more.</li>
<li><strong>2013-03</strong>: new color themes.</li>
<li><strong>2012-07</strong>: password protection for note editing added.</li>
<li><strong>2012-06</strong>: NoteHub 1.0 released as a result of an <a href="/2012/6/16/how-notehub-is-built">experiment</a>.</li>
<li><strong>2012-06</strong>: NoteHub 1.0 released as a result of an <a href="/story">experiment</a>.</li>
</ul>
</article>
<footer>
<a href="https://github.com/chmllr/NoteHub">source code</a> &middot;
<a href="https://github.com/chmllr/notehub">source code</a> &middot;
<a href="https://github.com/chmllr/notehub/issues">feedback</a> &middot;
<a href="/TOS.md">terms of service</a>
</footer>
</body>

11
package.json

@ -1,11 +0,0 @@ @@ -1,11 +0,0 @@
{
"name": "NoteHub",
"version": "3.0.0",
"main": "server.js",
"scripts": {
"test": "jasmine-node ."
},
"devDependencies": {
"frisby": "^0.8.5"
}
}
Loading…
Cancel
Save