Skip to content

Commit 89aabc0

Browse files
author
William Troup
committed
Updated main README files.
1 parent f285d1e commit 89aabc0

File tree

2 files changed

+217
-2
lines changed

2 files changed

+217
-2
lines changed

‎README.md‎

Lines changed: 118 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,118 @@
1-
# Select.js
1+
<h1 align="center">
2+
Select.js
3+
4+
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Select.js%2C%20a%20free%20JavaScript%select%builder&url=https://github.com/williamtroup/Select.js&hashtags=javascript,html,select)
5+
[![npm](https://img.shields.io/badge/npmjs-v0.1.0-blue)](https://www.npmjs.com/package/jselect.js)
6+
[![nuget](https://img.shields.io/badge/nuget-v0.1.0-purple)](https://www.nuget.org/packages/jSelect.js/)
7+
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Select.js/blob/main/LICENSE.txt)
8+
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Select.js/discussions)
9+
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://github.com/williamtroup)
10+
</h1>
11+
12+
> <p align="center">A lightweight, and easy-to-use, JavaScript library for creating multi-select drop-down lists!</p>
13+
> <p align="center">v0.1.1</p>
14+
<br />
15+
16+
![Select.js](docs/images/main.png)
17+
<br>
18+
<br>
19+
20+
<h1>What features does Select.js have?</h1>
21+
22+
- Zero-dependencies and extremely lightweight!
23+
- Full API available via public functions.
24+
- Fully styled in CSS/SASS (including the buttons) and compatible with the Bootstrap library.
25+
- Full CSS theme support (using :root variables, with a default dark-mode theme).
26+
- Custom triggers for actions (when elements are rendered, selection is changed, etc).
27+
<br />
28+
<br />
29+
30+
<h1>What browsers are supported?</h1>
31+
32+
All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.
33+
<br>
34+
<br>
35+
36+
<h1>What are the most recent changes?</h1>
37+
38+
To see a list of all the most recent changes, click [here](docs/CHANGE_LOG.md).
39+
<br>
40+
<br>
41+
42+
<h1>How do I get started?</h1>
43+
44+
To get started using Select.js, do the following steps:
45+
<br>
46+
<br>
47+
48+
### 1. Prerequisites:
49+
50+
Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:
51+
52+
```markdown
53+
<!DOCTYPE html>
54+
```
55+
<br>
56+
57+
### 2. Include Files:
58+
59+
```markdown
60+
<link rel="stylesheet" href="dist/select.js.css" />
61+
<script src="dist/select.js"></script>
62+
```
63+
<br>
64+
65+
### 3. Create DOM Container:
66+
67+
```markdown
68+
<select multiple="multiple" data-select-options="{ 'render': true }">
69+
<option value="1" selected="selected">Value 1</option>
70+
<option value="2">Value 2</option>
71+
<option value="2">Value 3</option>
72+
</select>
73+
74+
<select data-select-options="{ 'render': true }">
75+
<option value="1">Value 1</option>
76+
<option value="2">Value 2</option>
77+
<option value="2">Value 3</option>
78+
</select>
79+
```
80+
81+
To see a list of all the available binding options you can use for "data-select-options", click [here](docs/BINDING_OPTIONS.md).
82+
83+
To see a list of all the available custom triggers you can use for "data-select-options", click [here](docs/BINDING_OPTIONS_CUSTOM_TRIGGERS.md).
84+
85+
<br>
86+
87+
### 4. Finishing Up:
88+
89+
That's it! Nice and simple. Please refer to the code if you need more help (fully documented).
90+
<br>
91+
<br>
92+
93+
<h1>How do I go about customizing Select.js?</h1>
94+
95+
To customize, and get more out of Select.js, please read through the following documentation.
96+
<br>
97+
<br>
98+
99+
### 1. Public Functions:
100+
101+
To see a list of all the public functions available, click [here](docs/PUBLIC_FUNCTIONS.md).
102+
<br>
103+
<br>
104+
105+
106+
### 2. Configuration:
107+
108+
Configuration options allow you to customize how Select.js will function. You can set them as follows:
109+
110+
```markdown
111+
<script>
112+
$select.setConfiguration( {
113+
safeMode: false
114+
} );
115+
</script>
116+
```
117+
118+
To see a list of all the available configuration options you can use, click [here](docs/CONFIGURATION_OPTIONS.md).

‎README_NUGET.md‎

Lines changed: 99 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,99 @@
1-
# Select.js
1+
# Select.js v0.1.0
2+
3+
[![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Select.js%2C%20a%20free%20JavaScript%select%builder&url=https://github.com/williamtroup/Select.js&hashtags=javascript,html,select)
4+
[![npm](https://img.shields.io/badge/npmjs-v0.1.0-blue)](https://www.npmjs.com/package/jselect.js)
5+
[![nuget](https://img.shields.io/badge/nuget-v0.1.0-purple)](https://www.nuget.org/packages/jSelect.js/)
6+
[![license](https://img.shields.io/badge/license-MIT-green)](https://github.com/williamtroup/Select.js/blob/main/LICENSE.txt)
7+
[![discussions Welcome](https://img.shields.io/badge/discussions-Welcome-red)](https://github.com/williamtroup/Select.js/discussions)
8+
[![coded by William Troup](https://img.shields.io/badge/coded_by-William_Troup-yellow)](https://github.com/williamtroup)
9+
10+
> A lightweight, and easy-to-use, JavaScript library for creating multi-select drop-down lists!
11+
12+
13+
## What features does Select.js have?
14+
15+
- Zero-dependencies and extremely lightweight!
16+
- Full API available via public functions.
17+
- Fully styled in CSS/SASS (including the buttons) and compatible with the Bootstrap library.
18+
- Full CSS theme support (using :root variables, with a default dark-mode theme).
19+
- Custom triggers for actions (when elements are rendered, selection is changed, etc).
20+
21+
22+
## What browsers are supported?
23+
24+
All modern browsers (such as Google Chrome, FireFox, and Opera) are fully supported.
25+
26+
27+
## What are the most recent changes?
28+
29+
To see a list of all the most recent changes, click [here](https://github.com/williamtroup/Select.js/blob/main/docs/CHANGE_LOG.md).
30+
31+
32+
## How do I get started?
33+
34+
To get started using Select.js, do the following steps:
35+
36+
### 1. Prerequisites:
37+
38+
Make sure you include the "DOCTYPE html" tag at the top of your HTML, as follows:
39+
40+
```markdown
41+
<!DOCTYPE html>
42+
```
43+
44+
### 2. Include Files:
45+
46+
```markdown
47+
<link rel="stylesheet" href="dist/select.js.css" />
48+
<script src="dist/select.js"></script>
49+
```
50+
51+
### 3. Create DOM Container:
52+
53+
```markdown
54+
<select multiple="multiple" data-select-options="{ 'render': true }">
55+
<option value="1" selected="selected">Value 1</option>
56+
<option value="2">Value 2</option>
57+
<option value="2">Value 3</option>
58+
</select>
59+
60+
<select data-select-options="{ 'render': true }">
61+
<option value="1">Value 1</option>
62+
<option value="2">Value 2</option>
63+
<option value="2">Value 3</option>
64+
</select>
65+
```
66+
67+
To see a list of all the available binding options you can use for "data-select-options", click [here](https://github.com/williamtroup/Select.js/blob/main/docs/BINDING_OPTIONS.md).
68+
69+
To see a list of all the available custom triggers you can use for "data-select-options", click [here](https://github.com/williamtroup/Select.js/blob/main/docs/BINDING_OPTIONS_CUSTOM_TRIGGERS.md).
70+
71+
72+
### 4. Finishing Up:
73+
74+
That's it! Nice and simple. Please refer to the code if you need more help (fully documented).
75+
76+
77+
## How do I go about customizing Select.js?
78+
79+
To customize, and get more out of Select.js, please read through the following documentation.
80+
81+
82+
### 1. Public Functions:
83+
84+
To see a list of all the public functions available, click [here](https://github.com/williamtroup/Select.js/blob/main/docs/PUBLIC_FUNCTIONS.md).
85+
86+
87+
### 2. Configuration:
88+
89+
Configuration options allow you to customize how Select.js will function. You can set them as follows:
90+
91+
```markdown
92+
<script>
93+
$select.setConfiguration( {
94+
safeMode: false
95+
} );
96+
</script>
97+
```
98+
99+
To see a list of all the available configuration options you can use, click [here](https://github.com/williamtroup/Select.js/blob/main/docs/CONFIGURATION_OPTIONS.md).

0 commit comments

Comments
 (0)