Skip to content

Commit 6063787

Browse files
committed
Merge pull request #16 from bdukes/readme
Add roadmap to readme
2 parents afcb79a + c646b87 commit 6063787

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

README.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,13 @@ of a script, while another requests another. So long as they aren't on the same
1515
page, they will get what they requested; otherwise, DNN will use the higher
1616
version.
1717

18+
Packages
19+
===============
20+
21+
The installable packages are included within this GitHub repository as
22+
[releases](/EngageSoftware/DNN-JavaScript-Libraries/releases). They are also
23+
published on the [DNN Forge](http://www.dnnsoftware.com/forge).
24+
1825

1926
Goal
2027
===============
@@ -27,6 +34,7 @@ to aid in that goal, we are attempting to create a central repository
2734
of common JavaScript Libraries that can be used by many different DNN extension
2835
developers.
2936

37+
3038
Usage
3139
===============
3240

@@ -93,15 +101,41 @@ the library will indicate its preferred location (from page head, body top, and
93101
body bottom), and can provide a URL to the script on a
94102
<abbr title="Content Distribution Network">CDN</abbr> (along with a JavaScript
95103
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
104+
DNN can fallback to the local version if the CDN is down). The host
105+
administrator can configure whether to use the CDN or not (it is off by
106+
default).
98107

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

106140
License
107141
===============

0 commit comments

Comments
 (0)