Skip to content

Commit c13c110

Browse files
docs: update README.md with badges, formatting
1 parent 1610db0 commit c13c110

File tree

1 file changed

+24
-20
lines changed

1 file changed

+24
-20
lines changed

README.md

+24-20
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
# @conjoon/extjs-app-webmail
1+
# @conjoon/extjs-app-webmail ![MIT](https://img.shields.io/npm/l/@conjoon/extjs-app-webmail) [![npm version](https://badge.fury.io/js/@conjoon%2Fextjs-app-webmail.svg)](https://badge.fury.io/js/@conjoon%2Fextjs-app-webmail)
2+
3+
24
This Sencha ExtJS NPM package is built with the [coon.js-library](https://github.com/coon.js) and provides a webmail client
35
implementation for the [conjoon](https://github.com/conjoon/conjoon) application.
46

57
## Installation
6-
```
7-
npm install --save-dev @conjoon/extjs-app-webmail
8+
```bash
9+
$ npm install --save-dev @conjoon/extjs-app-webmail
810
```
911
If you want to develop with this package, run the `build:dev`-script afterwards:
1012
```bash
@@ -16,12 +18,29 @@ Testing environment will then be available via
1618
npm test
1719
```
1820

21+
For using the package as an external dependency in an application, use
22+
```bash
23+
$ npm install --save-prod @conjoon/extjs-app-webmail
24+
```
25+
In your `app.json`, add this package as a requirement, and make sure your ExtJS `workspace.json`
26+
is properly configured to look up local repositories in the `node_modules`-directory.
27+
28+
Example (`workspace.json`) :
29+
```json
30+
{
31+
"packages": {
32+
"dir": "${workspace.dir}/node_modules/@l8js,${workspace.dir}/node_modules/@conjoon,${workspace.dir}/node_modules/@coon-js,${workspace.dir}/packages/local,${workspace.dir}/packages,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name},${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-treegrid,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-base,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-ios,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-material,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-aria,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-neutral,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-classic,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-gray,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-crisp,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-crisp-touch,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-neptune,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-neptune-touch,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-triton,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-graphite,${workspace.dir}/node_modules/@sencha/ext-${toolkit.name}-theme-material,${workspace.dir}/node_modules/@sencha/ext-calendar,${workspace.dir}/node_modules/@sencha/ext-charts,${workspace.dir}/node_modules/@sencha/ext-d3,${workspace.dir}/node_modules/@sencha/ext-exporter,${workspace.dir}/node_modules/@sencha/ext-pivot,${workspace.dir}/node_modules/@sencha/ext-pivot-d3,${workspace.dir}/node_modules/@sencha/ext-ux,${workspace.dir}/node_modules/@sencha/ext-font-ios",
33+
"extract": "${workspace.dir}/packages/remote"
34+
}
35+
}
36+
```
37+
1938
## Usage
2039
When using this package without a backend implementation, make sure your app uses the [extjs-dev-webmailsim](https://github.com/conjoon/extjs-dev-webmailsim) package of the [conjoon](https://github.com/conjoon) project.
2140

2241
### Required Services
2342
This package requires a service that complies with the REST API described in `rest-imap` which can be found
24-
in the [REST API description](https://github.com/conjoon/rest-api-descriptions) of the conjoon project.
43+
in the [REST API description](https://github.com/conjoon/rest-api-description) of the **conjoon**-project.
2544

2645
The url of this service can be configured in the configuration file for this package.
2746

@@ -35,19 +54,4 @@ The url of this service can be configured in the configuration file for this pac
3554
}
3655
```
3756
Please refer to the documentation of [extjs-lib-core](https://github.com/coon-js/extjs-lib-core) on how to
38-
create package-specific configurations.
39-
40-
### Dev Notes
41-
42-
#### Namespace
43-
`conjoon.cn_mail.*`
44-
#### Package name
45-
`extjs-app-webmail`
46-
#### Shorthand to be used with providing aliases
47-
`cn_mail`
48-
49-
**Example:**
50-
Class `conjoon.cn_mail.view.mail.MailDesktopViewModel` has the alias `viewmodel.cn_mail-maildesktopviewmodel`
51-
52-
## Tests
53-
Tests are written with [Siesta](https://bryntum.com/siesta)
57+
create package-specific configurations.

0 commit comments

Comments
 (0)