Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated Readme.md with new Screenshots + Example file #105

Closed
wants to merge 6 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 14 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,34 +1,34 @@
# NextNote (alpha)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/brantje/nextnote/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/brantje/nextnote/?branch=master)
This application is a rewritten verion of ownNote.<br>
This application is a rewritten verion of [ownNote](https://github.com/Fmstrat/ownnote).<br>
The old [Android App](https://play.google.com/store/apps/details?id=com.nowsci.ownnote&hl=sv) won't work, but no worries, we plan to develop a new one.

Alpha means in this case 'pretty stable', but it's possible that due an update things will break / get send to `/dev/null`.
If you value your notes please wait for a stable version.
![alpha-release](https://user-images.githubusercontent.com/1787238/38750516-0adbd372-3f0a-11e8-9120-6521cf3232a5.gif)<br>
Alpha means in this case 'pretty stable', but it's possible that due to an update things will break / get sent to `/dev/null`.<br>
**If you value your notes please wait for a stable version.**

Changes:
- Replaced deprecated methods
- Removed XSS vulnerability (Via the announcements it was possible to inject javascript / html)
- Updated tiny MCE to 4.7.10.
- Fixed CSP error in tinymce.
- Updated [tiny MCE](https://github.com/tinymce/tinymce) to 4.7.10.
- Fixed CSP error in [tinymce](https://github.com/tinymce/tinymce).
- Ability to embed files from your nextcloud
- Ability to link to files from your nextcloud
- Make use of Entity's, mappers, services

## Pull requests are very welcome!
The whole app has been rebuild, so there will be some bugs in there.
Did you found a bug? Report it or fix it and send a PR.
Did you find a bug? Report it or fix it and send a PR.

## Screenshots
![Desktop](https://i.imgur.com/0uahxKS.png)
![save-as-pdf-example-smaller](https://user-images.githubusercontent.com/1787238/38752055-c6f0db1c-3f0e-11e8-8b57-920f1a709b38.gif)

![Mobile 1](https://i.imgur.com/DhYzfHO.png)

![Mobile 2](https://i.imgur.com/0daW6nc.png)
![recipe-example](https://user-images.githubusercontent.com/1787238/38751463-0fb851c4-3f0d-11e8-867e-0db143f730e1.png)

![nexnote-drag-and-drop-example-bigger](https://user-images.githubusercontent.com/1787238/38581663-58ecc3b8-3cc2-11e8-9011-970ace95a5f5.gif)

## Features
- Full fledged WYSIWYG editor
- Full fledged [WYSIWYG editor](https://github.com/tinymce/tinymce)
- Share a note with a user or group
- Note grouping/categorization
- Archive notes
Expand All @@ -41,9 +41,9 @@ Did you found a bug? Report it or fix it and send a PR.
- [x] Services
- [x] Switch to a AngularJS frontend
- [X] Rename namespace from OwnNotes to NextNotes
- [ ] Implement note sharing
- [ ] Import from Evernote
- [ ] Ability to save files to a folder as HTML files (untested)
- [ ] Implement [note sharing](https://github.com/brantje/nextnote/issues/81)
- [ ] Import from Evernote as HTML or [ENEX](https://github.com/brantje/nextnote/issues/75)
- [ ] Ability to [save files to a folder as HTML files](https://github.com/brantje/nextnote/issues/96) (untested)
- [ ] Implement hierarchical structure for groups (PR's welcome!)
- [ ] Add markdown support
- [ ] Import from [Notes](https://github.com/nextcloud/notes) app.
Expand Down
21 changes: 18 additions & 3 deletions lib/Fixtures/ExampleNote.php
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,21 @@
namespace OCA\NextNote\Fixtures;

class ExampleNote {
const TITLE = 'Example note';
const NOTE_CONTENT = 'Some example note... If you think this content could be better, send a PR';
}
const TITLE = 'Welcome to NextNote';
const NOTE_CONTENT = '<h5 style=text-align:center>Welcome to <a href=https://github.com/brantje/nextnote rel=noopener target=_blank>NextNote</a>! Notes are saved in Rich Text format.</h5>
<p>This app is considered an <strong><span style=background-color:#0ff;color:red>ALPHA</span></strong> release. <strong>Complete note loss is to be expected</strong> until <a href=https://github.com/brantje/nextnote/issues/50>sharing is fixed</a>, <a href=https://github.com/brantje/nextnote/issues/49>a version 1.0 release is added to the Nextcloud Appstore</a> and basic <a href=https://github.com/brantje/nextnote/issues/96 rel=noopener target=_blank>note import/export functionality</a> is implemented.</p>
<h5 style=text-align:center>Thanks for your interest! Still Want to help us test?</h5>
<ol>
<li>Join our <img alt=cool src=../../../apps/nextnote/js/vendor/tinymce/plugins/emoticons/img/smiley-cool.gif> <span style=background-color:#fc9>Telegram Chat</span>: <a href=https://t.me/nextnote>https://t.me/nextnote</a></li>
<li>You'll need SSH or terminal access to update NextNote to the latest build.</li>
<li><code>git pull</code> to update to the latest code -- <a href=https://github.com/brantje/nextnote/commits/master>updates are constant</a>.</li>
<li>Please report any issues with <a href=https://github.com/brantje/nextnote/issues rel=noopener target=_blank>NextNote here</a>.</li>
<li><a href=https://www.tinymce.com rel=noopener target=_blank>TinyMCE</a>, the rich text js library for NextNote, can receive bug reports here. <a href=https://github.com/tinymce/tinymce rel=noopener target=_blank>https://github.com/tinymce/tinymce</a></li>
<li>We appreciate your support!</li>
</ol>
<h5><strong>FAQ’s</strong></h5>
<p><em>Where is flat file/Markdown support, folder support, Etc.?</em></p>
<p style=text-align:left;padding-left:30px>Right now the focus is on stability and sharing. These additional features are on the hopeful roadmap.</p>
<p><em>Are keyboard shortcuts supported?</em></p>
<p style=padding-left:30px>Yes, they are! Just press <span style=font-size:12pt><strong>?</strong></span> in the menu to view them!';
}