Skip to content

Commit 89b0145

Browse files
committed
Updated documentation and build cleanup
1 parent a770ce6 commit 89b0145

File tree

7 files changed

+16
-16
lines changed

7 files changed

+16
-16
lines changed

.travis.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

Gruntfile.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -104,9 +104,9 @@ module.exports = function(grunt) {
104104
shell: {
105105

106106
clean: {
107-
command: ["rm -rf dist",
107+
command: ["rm -rf dist webpack_files",
108108
"cd openNote/style/invert/",
109-
"rm -rf dark light"
109+
"rm -rf dark light",
110110
].join("&&")
111111
},
112112
test: {

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# OpenNote [![Build Status](https://travis-ci.org/FoxUSA/OpenNote.png?branch=master)](https://travis-ci.org/FoxUSA/OpenNote)
1+
# OpenNote
22

33
![][responsive]
44
OpenNote is a progressive web application(PWA)/HTML5 offline app that was built to be a open source(MIT License), web based text editor/note taking software.

docs/Build.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ You can see a full list of commands by running `grunt --help`.
2929
Below are the most important commands
3030
- `grunt default` or `grunt` to have webpack in development mode
3131
- `grunt ci` run linting and tests
32-
- `grunt deploy` Package up the project
32+
- `grunt deploy` Package up the project into the `dist` folder. Creates a zip with the version number that can be uploaded to Github.
3333

3434

3535
To develop tests

docs/History.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,17 @@
33
Back in 2013 OneNote was started. Back then Microsoft OneNote did not have a full featured web interface. I used that at the time and had many notebooks. I wanted a way of taking those notes with me on my phone. I had limited data and wanted an application that would sync all my notes, let me modify them, and sync them back. I tried a bunch of applications and there were none that fulfilled my offline and tree structure requirements.
44

55
## Open note
6-
OpenNote has a text only design. No icons or symbols other than ascii non alphabetical characters. The application just so happened to end up this way. It has a very clean feel to it and does not distract you. I would like to keep this going forward
7-
### Generation Alpha
6+
OpenNote has a text only design. No icons or symbols other than ascii non alphabetical characters. The application just so happened to end up this way. It has a very clean feel to it and does not distract you. I would like to keep this going forward.
7+
8+
**Why emphasis on text?** Text is a really old medium for storing information. All sorts of style and support for it. Computers store text really efficiently in comparison to blob data like images.
9+
10+
11+
### OpenNote Generations
12+
#### Generation Alpha
813
The first version of OpenNote was a PHP fat application. Views were prepared by PHP and sent to the browser via a full load or AJAX.
914

10-
### Generation Beta
15+
#### Generation Beta
1116
Second major revision was the switch to the then booming Angular 1 framework and use HTML5 application manifest and CouchDB to provided offline access and syncing.
1217

13-
### Current Generation
18+
#### Current Generation
1419
The most recent efforts have been to add modern features. Tags, markdown, and a CLI.

docs/HowToUse.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
^ ^
99
| |
1010
| |PouchDB sync
11-
|Pre-signed urls |
11+
|Pre-signed urls (De-coupled) |
1212
| |
1313
v v
1414
+----+-------------------------+ +----------------------------+----------+
@@ -23,7 +23,7 @@ Component | Purpose
2323
--------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
2424
OpenNote | A PWA(Offline compatible) web application that allows you edit and access notes.
2525
CouchDB | Couch DB is a database that stores your notes. When this is setup, you do not need to worry if your phone gets lost. When fully replicated, your notes will be safely stored in CouchDB. CouchDB also allows multiple browsers to sync. So you can have your notes on all your devices.
26-
Minio | Minio is a blob storage server that implements the AWS S3 API. This allows you to upload your images and non text files for use with OpenNote/
26+
Minio | Minio is a blob storage server that implements the AWS S3 API. This allows you to upload your images and non text files for use with OpenNote.
2727
[OpenNote-CLI](https://github.com/FoxUSA/OpenNote-CLI) | OpenNote CLI syncs the database to disk. This allows you to use other editors like Atom to create and edit notes.
2828

2929
## General

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "OpenNote",
3-
"version": "18.03.00-Alpha",
3+
"version": "18.03.00",
44
"description": "",
55
"main": "Gruntfile.js",
66
"author": "Jacob Liscom",

0 commit comments

Comments
 (0)