Skip to content

Commit fa70f26

Browse files
committed
Add roadmap to readme
1 parent afcb79a commit fa70f26

File tree

1 file changed

+29
-2
lines changed

1 file changed

+29
-2
lines changed

README.md

Lines changed: 29 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ to aid in that goal, we are attempting to create a central repository
2727
of common JavaScript Libraries that can be used by many different DNN extension
2828
developers.
2929

30+
3031
Usage
3132
===============
3233

@@ -93,15 +94,41 @@ the library will indicate its preferred location (from page head, body top, and
9394
body bottom), and can provide a URL to the script on a
9495
<abbr title="Content Distribution Network">CDN</abbr> (along with a JavaScript
9596
expression to use to verify that the CDN loaded the script correctly, so that
96-
DNN can fallback to the local version if the CDN is down). The site
97-
administrator
97+
DNN can fallback to the local version if the CDN is down). The host
98+
administrator can configure whether to use the CDN or not (it is off by
99+
default).
98100

99101
The other main feature that JavaScript Libraries give you is de-duplication of
100102
scripts. This means that if your module and your skin both request the
101103
[html5shiv library](http://www.dnnsoftware.com/forge/html5shiv), it only gets
102104
included on the page once (rather than both components including their own
103105
version of the script). Likewise, if both components request different versions
104106
of the script, just the higher version will be included.
107+
108+
109+
Roadmap
110+
===============
111+
112+
The obvious next step for this project is to add more libraries. There's a
113+
short list in [the Issues list for this repo](/EngageSoftware/DNN-JavaScript-Libraries/issues),
114+
but we would eventually like to make it very easy to add any reusable script to
115+
the repository. To do that, we'll need to invest in better integration with a
116+
script package manager, probably [Bower](http://bower.io/), so that with very
117+
little effort, we can get the latest version of a script, package it, and
118+
publish it.
119+
120+
In addition, there are some enhancements to DNN itself that would help this be
121+
an even more useful tool. The main enhancement is to provide a similar mechanism
122+
for shared CSS components. For example, many jQuery plugins are going to include
123+
basic styles to make them work. It would be nice if there was a way to get CSS
124+
that matched the requested JavaScript Library. Also, JavaScript libraries with
125+
multiple JavaScript files could be handled together more cleanly, rather than as
126+
a bunch of separate libraries. Finally, one of the big ways that would make
127+
this more of a no-brainer is if the extension installation process automatically
128+
found dependent packages on the [DNN Forge](http://www.dnnsoftware.com/forge)
129+
rather than asking clients to install the JavaScript Library package(s) before
130+
installing your component.
131+
105132

106133
License
107134
===============

0 commit comments

Comments
 (0)