From 42d6d114f9552f67652ae1b4519f878b0b09f2f6 Mon Sep 17 00:00:00 2001 From: "S. Andrew Sheppard" Date: Mon, 19 Apr 2021 11:49:10 +0900 Subject: [PATCH] update readme --- README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 52773ee..ed0d62f 100644 --- a/README.md +++ b/README.md @@ -3,10 +3,10 @@ This is the recommended Django project template for projects utilizing the [wq framework]. It uses [wq.app] for the front end and [wq.db] as the backend component. This template is meant to be used together with [wq.create]. See wq's [Getting Started] docs for more information. -This template provides two alternatives for managing JavaScript dependencies ([@wq/app] & [wq.app]). The alternatives can be selected by passing the `--with-npm` or `--without-npm` arguments to the `wq create` command. +This template provides two alternatives for managing JavaScript dependencies: [@wq/app] & [wq.app]. The alternatives can be selected by passing the `--with-npm` or `--without-npm` arguments to the `wq create` command. * `--with-npm`: `wq create` will generate an app/ folder based on the [@wq Create React App template][@wq/cra-template] and install [@wq/app] and [@wq/material] from NPM. - * `--without-npm`: `wq create` will generate an app/ folder containing a minimal web-ready JavaScript configuration that can be merged with [wq.app]'s assets by running `./manage.py collectstatic`. This leverages a new pre-compiled and minified ESM module, [**wq.js**](https://npmjs.com/package/wq), introduced in wq.app 1.3. + * `--without-npm`: `wq create` will generate an app/ folder containing a minimal web-ready JavaScript configuration that can be merged with [wq.app]'s assets by running `./manage.py collectstatic`. This leverages a new pre-compiled and minified ESM module, [**wq.js**][wq], introduced in wq.app 1.3. > Note: Existing RequireJS + jQuery Mobile + Mustache projects (created with wq.start 1.2 and earlier) will still work with wq.app 1.3. However, wq.create 1.3 does not support creating new RequireJS projects. Remaining support for RequireJS and jQuery Mobile will be removed in wq.app 2.0. @@ -20,16 +20,17 @@ This project template is also useful as an example of how to build a web app wit * A default Apache2 WSGI configuration is included in `conf/` [wq framework]: http://wq.io/ -[wq.app]: https://wq.io/wq.app -[wq.db]: https://wq.io/wq.db -[wq.create]: https://wq.io/wq.create -[Getting Started]: https://wq.io/docs/setup - -[@wq/app]: https://wq.io/docs/app-js -[@wq/cra-template]: https://github.com/wq/wq.create/tree/master/packages/cra-template -[@wq/material]: https://github.com/wq/wq.app/tree/master/packages/material -[@wq/react]: https://github.com/wq/wq.app/tree/master/packages/react -[@wq/store]: https://github.com/wq/wq.app/tree/master/packages/store +[wq.app]: https://wq.io/wq.app/ +[wq.db]: https://wq.io/wq.db/ +[wq.create]: https://wq.io/wq.create/ +[Getting Started]: https://wq.io/overview/setup + +[wq]: https://wq.io/wq +[@wq/app]: https://wq.io/@wq/app +[@wq/cra-template]: https://wq.io/@wq/cra-template +[@wq/material]: https://wq.io/@wq/material +[@wq/react]: https://wq.io/@wq/react +[@wq/store]: https://wq.io/@wq/store [React]: https://reactjs.org/ [Django REST Framework]: http://www.django-rest-framework.org