Skip to content

Commit b30d79b

Browse files
commit on 18-12-2023
1 parent 9335239 commit b30d79b

File tree

15 files changed

+12654
-1
lines changed

15 files changed

+12654
-1
lines changed

AUTHORS.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Shahzada Modassir <codingmodassir@gmail.com>

README.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,55 @@
11
# jqrony
2-
jQrony is fast feature-rich pure Javascript Library
2+
3+
> jqrony is a fast, small, and feature-rich JavaScript library.
4+
5+
## Including jqrony
6+
7+
Below are some of the most common ways to include jqrony.
8+
9+
### Browser
10+
11+
#### Script tag
12+
13+
```html
14+
<script src="https://code.jqrony.com/jqrony-1.0.0.min.js"></script>
15+
```
16+
17+
#### Webpack / Browserify / Babel
18+
19+
There are several ways to use [Webpack](https://webpack.js.org/), [Browserify](http://browserify.org/) or [Babel](https://babeljs.io/). For more information on using these tools, please refer to the corresponding project's documentation. In the script, including jqrony will usually look like this:
20+
21+
```js
22+
import $ from "jqrony";
23+
```
24+
25+
If you need to use jqrony in a file that's not an ECMAScript module, you can use the CommonJS syntax:
26+
27+
```js
28+
var $ = require( "jqrony" );
29+
```
30+
31+
#### AMD (Asynchronous Module Definition)
32+
33+
AMD is a module format built for the browser. For more information, we recommend [require.js' documentation](https://requirejs.org/docs/whyamd.html).
34+
35+
```js
36+
define( [ "jqrony" ], function( $ ) {
37+
38+
} );
39+
```
40+
41+
### Node
42+
43+
To include jqrony in [Node](https://nodejs.org/), first install with npm.
44+
45+
```sh
46+
npm install jqrony
47+
```
48+
49+
For jqrony to work in Node, a window with a document is required. Since no such window exists natively in Node, one can be mocked by tools such as [jsdom](https://github.com/jsdom/jsdom). This can be useful for testing purposes.
50+
51+
```js
52+
const { JSDOM } = require( "jsdom" );
53+
const { window } = new JSDOM( "" );
54+
const $ = require( "jqrony" )( window );
55+
```

bower.json

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "jqrony",
3+
"main": "dist/jqrony.js",
4+
"license": "MIT",
5+
"version": "1.0.0",
6+
"ignore": [
7+
"package.json"
8+
],
9+
"keywords": [
10+
"jqrony",
11+
"javascript",
12+
"selector",
13+
"library",
14+
"browser",
15+
"chrome"
16+
]
17+
}

codeowners

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
#
2+
# pattern:
3+
#
4+
# file/directory user
5+
6+
7+
*.js @shahzadamodassir

dist/jqrony-min.js

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)