diff --git a/CHANGELOG.md b/CHANGELOG.md index 93e174e..d2a4cbd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## [0.1.4]: 2018-08-29 +### Added +- Some styles fixed. + ## [0.1.3]: 2018-04-26 ### Added - Some styles fixed. diff --git a/README.md b/README.md index 53e2aeb..76f9a7d 100644 --- a/README.md +++ b/README.md @@ -1,52 +1,12 @@ -# Quick Notes -Place this app in **owncloud/apps/** +# Quick notes -## Building the app +The Quick notes application, is an application to take quick notes -Forgive the +redundancy :sweat_smile:- on small cards, organizedby colors -And in future +categories-. It allows a basic rich text as **Bold**, *italic*, and numbered or +bullet list, to improve the notes. -The app can be built by using the provided Makefile by running: +![App screenshots](/doc/quicknotes-screenshot.png "App screenshots") - make +## Instalation -This requires the following things to be present: -* make -* which -* tar: for building the archive -* curl: used if phpunit and composer are not installed to fetch them from the web -* npm: for building and testing everything JS, only required if a package.json is placed inside the **js/** folder - -The make command will install or update Composer dependencies if a composer.json is present and also **npm run build** if a package.json is present in the **js/** folder. The npm **build** script should use local paths for build systems and package managers, so people that simply want to build the app won't need to install npm libraries globally, e.g.: - -**package.json**: -```json -"scripts": { - "test": "node node_modules/gulp-cli/bin/gulp.js karma", - "prebuild": "npm install && node_modules/bower/bin/bower install && node_modules/bower/bin/bower update", - "build": "node node_modules/gulp-cli/bin/gulp.js" -} -``` - - -## Publish to App Store - -First get an account for the [App Store](http://apps.owncloud.com/) then run: - - make appstore - -The archive is located in build/artifacts/appstore and can then be uploaded to the App Store. - -## Running tests -You can use the provided Makefile to run all tests by using: - - make test - -This will run the PHP unit and integration tests and if a package.json is present in the **js/** folder will execute **npm run test** - -Of course you can also install [PHPUnit](http://phpunit.de/getting-started.html) and use the configurations directly: - - phpunit -c phpunit.xml - -or: - - phpunit -c phpunit.integration.xml - -for integration tests \ No newline at end of file +Quick notes is available in the Nextcloud App Store and can be installed directly from your Nextcloud installation looking in the category Office. \ No newline at end of file diff --git a/appinfo/info.xml b/appinfo/info.xml index ed7bddf..acb30bd 100644 --- a/appinfo/info.xml +++ b/appinfo/info.xml @@ -5,8 +5,9 @@ Quick notes with a basic rich text AGPL Matias De lellis - 0.1.3 + 0.1.4 QuickNotes + office tools https://github.com/matiasdelellis/quicknotes https://github.com/matiasdelellis/quicknotes/issues diff --git a/doc/quicknotes-screenshot.png b/doc/quicknotes-screenshot.png new file mode 100644 index 0000000..893fb28 Binary files /dev/null and b/doc/quicknotes-screenshot.png differ