Skip to content

Commit af03522

Browse files
committed
updating README
1 parent ee4ab89 commit af03522

File tree

2 files changed

+55
-57
lines changed

2 files changed

+55
-57
lines changed

README.md

Lines changed: 52 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -4,17 +4,18 @@
44
[![Downloads][downloads-image]][npm-url]
55
[![Twitter Follow][twitter-image]][twitter-url]
66

7-
[npm-image]:http://img.shields.io/npm/v/nativescript-ngx-slides.svg
8-
[npm-url]:https://npmjs.org/package/nativescript-ngx-slides
9-
[downloads-image]:http://img.shields.io/npm/dt/nativescript-ngx-slides.svg
10-
[twitter-image]:https://img.shields.io/twitter/follow/_joshsommer.svg?style=social&label=Josh%20Sommer
11-
[twitter-url]:https://twitter.com/_joshsommer
12-
7+
[npm-image]: http://img.shields.io/npm/v/nativescript-ngx-slides.svg
8+
[npm-url]: https://npmjs.org/package/nativescript-ngx-slides
9+
[downloads-image]: http://img.shields.io/npm/dt/nativescript-ngx-slides.svg
10+
[twitter-image]: https://img.shields.io/twitter/follow/_joshsommer.svg?style=social&label=Josh%20Sommer
11+
[twitter-url]: https://twitter.com/_joshsommer
1312

1413
### Intro slides example:
14+
1515
[![Nativescript Slides. Click to Play](https://img.youtube.com/vi/kGby8qtSDjM/0.jpg)](https://www.youtube.com/embed/kGby8qtSDjM)
1616

1717
### Image carousel example:
18+
1819
[![Nativescript Slides. Click to Play](https://img.youtube.com/vi/RsEqGAKm62k/0.jpg)](https://www.youtube.com/embed/RsEqGAKm62k)
1920

2021
_videos are from the NativeScript Slides plugin. all features may not be implemented yet._
@@ -24,23 +25,22 @@ _videos by [Brad Martin](https://github.com/bradmartin)_
2425
## Example Usage:
2526

2627
```ts
27-
import { SlidesModule } from 'nativescript-ngx-slides';
28+
import { SlidesModule } from "nativescript-ngx-slides";
2829

2930
import { AppComponent } from "./app.component";
3031

3132
@NgModule({
32-
declarations: [AppComponent],
33-
bootstrap: [AppComponent],
34-
imports: [NativeScriptModule, SlidesModule],
35-
schemas: [NO_ERRORS_SCHEMA]
33+
declarations: [AppComponent],
34+
bootstrap: [AppComponent],
35+
imports: [NativeScriptModule, SlidesModule],
36+
schemas: [NO_ERRORS_SCHEMA]
3637
})
37-
export class AppModule { }
38-
38+
export class AppModule {}
3939
```
4040

4141
### XML
42-
```xml
4342

43+
```xml
4444
<slides>
4545
<slide class="slide-1">
4646
<Label text="This is Panel 1"></Label>
@@ -58,47 +58,46 @@ export class AppModule { }
5858
<Label text="This is Panel 5"></Label>
5959
</slide>
6060
</slides>
61-
6261
```
62+
6363
### CSS
6464

65-
place this in the app.css file in the root of your project.
65+
place this in the app.css file in the root of your project.
6666

6767
```css
68-
.slide-1{
68+
.slide-1 {
6969
background-color: darkslateblue;
7070
}
7171

72-
.slide-2{
72+
.slide-2 {
7373
background-color: darkcyan;
7474
}
75-
.slide-3{
75+
.slide-3 {
7676
background-color: darkgreen;
7777
}
7878

79-
.slide-4{
79+
.slide-4 {
8080
background-color: darkgoldenrod;
8181
}
82-
.slide-5{
82+
.slide-5 {
8383
background-color: darkslategray;
8484
}
85-
Label{
85+
label {
8686
text-align: center;
8787
width: 100%;
8888
font-size: 35;
8989
margin-top: 35;
90-
color: #fff;
91-
90+
color: #fff;
9291
}
93-
9492
```
93+
9594
Great for Intros/Tutorials to Image Carousels.
9695

9796
This very much a work in progress. Please feel free to contribute.
9897

9998
### Attributes for SlideContainer
10099

101-
- **loop : boolean** - If true will cause the slide to be an endless loop. The suggested use case would be for a Image Carousel or something of that nature.
100+
- **loop : boolean** - If true will cause the slide to be an endless loop. The suggested use case would be for a Image Carousel or something of that nature.
102101

103102
- **pageIndicators : boolean** - If true adds indicator dots to the bottom of your slides.
104103

@@ -107,53 +106,52 @@ This very much a work in progress. Please feel free to contribute.
107106
If the property `pageIndicators` is `true` you won't see the page indicators anymore as of 2.0.0 right away. there are two css classes exposed that you can setup however you like for active and inactive indicators. below is an example for semi translucent dots.
108107

109108
```css
110-
.slide-indicator-inactive{
111-
background-color: #fff;
112-
opacity : 0.4;
113-
width : 10;
114-
height : 10;
115-
margin-left : 2.5;
116-
margin-right : 2.5;
117-
margin-top : 0;
118-
border-radius : 5;
109+
.slide-indicator-inactive {
110+
background-color: #fff;
111+
opacity: 0.4;
112+
width: 10;
113+
height: 10;
114+
margin-left: 2.5;
115+
margin-right: 2.5;
116+
margin-top: 0;
117+
border-radius: 5;
119118
}
120119

121-
.slide-indicator-active{
122-
background-color: #fff;
123-
opacity : 0.9;
124-
width : 10;
125-
height : 10;
126-
margin-left : 2.5;
127-
margin-right : 2.5;
128-
margin-top : 0;
129-
border-radius : 5;
120+
.slide-indicator-active {
121+
background-color: #fff;
122+
opacity: 0.9;
123+
width: 10;
124+
height: 10;
125+
margin-left: 2.5;
126+
margin-right: 2.5;
127+
margin-top: 0;
128+
border-radius: 5;
130129
}
131130
```
132131

133132
#### Plugin Development Work Flow:
134133

135-
* Clone repository to your machine.
136-
* Run `npm run setup` to prepare the demo project
137-
* Build with `npm run build`
138-
* Run and deploy to your device or emulator with `npm run demo.android` or `npm run demo.ios`
134+
- Clone repository to your machine.
135+
- Run `npm install` to prepare the project
136+
- Run and deploy to your device or emulator with `npm run android` or `npm run ios`
137+
- Build a ngPackagr version with `npm run build`
139138

140139
#### Known issues
141140

142-
* Does not work well inside of ScrollView or TabViews.
141+
- Does not work well inside of ScrollView or TabViews.
143142

144143
## Contributors
145144

146-
[<img alt="TheOriginalJosh" src="https://avatars.githubusercontent.com/u/1486275?v=3&s=117" width="117">](https://github.com/TheOriginalJosh) | [<img alt="dobjek" src="https://avatars.githubusercontent.com/u/353596?v=3&s=117" width="117">](https://github.com/dobjek)| [<img alt="EddyVerbruggen" src="https://avatars.githubusercontent.com/u/1426370?v=3&s=117" width="117">](https://github.com/EddyVerbruggen)| [<img alt="Marco Mantovani" src="https://avatars.githubusercontent.com/u/1965169?v=3&s=117" width="117">](https://github.com/codeback)
147-
:---: |:---: |:---: |:---: |
148-
[Josh Sommer](https://github.com/TheOriginalJosh) |[dobjek](https://github.com/dobjek) |[Eddy Verbruggen](https://github.com/EddyVerbruggen)|[Codeback Software](https://github.com/codeback)
145+
| [<img alt="TheOriginalJosh" src="https://avatars.githubusercontent.com/u/1486275?v=3&s=117" width="117">](https://github.com/TheOriginalJosh) | [<img alt="dobjek" src="https://avatars.githubusercontent.com/u/353596?v=3&s=117" width="117">](https://github.com/dobjek) | [<img alt="EddyVerbruggen" src="https://avatars.githubusercontent.com/u/1426370?v=3&s=117" width="117">](https://github.com/EddyVerbruggen) | [<img alt="Marco Mantovani" src="https://avatars.githubusercontent.com/u/1965169?v=3&s=117" width="117">](https://github.com/codeback) |
146+
| :-------------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------: | :-----------------------------------------------------------------------------------------------------------------------------------------: | :------------------------------------------------------------------------------------------------------------------------------------: |
147+
| [Josh Sommer](https://github.com/TheOriginalJosh) | [dobjek](https://github.com/dobjek) | [Eddy Verbruggen](https://github.com/EddyVerbruggen) | [Codeback Software](https://github.com/codeback) |
149148

150149
## Contributing guidelines
150+
151151
[Contributing guidelines](https://github.com/TheOriginalJosh/nativescript-swiss-army-knife/blob/master/CONTRIBUTING.md)
152152

153153
## License
154154

155155
[MIT](/LICENSE)
156156

157157
for {N} version 2.0.0+
158-
159-

lib/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,9 @@ If the property `pageIndicators` is `true` you won't see the page indicators any
132132
#### Plugin Development Work Flow:
133133

134134
- Clone repository to your machine.
135-
- Run `npm run setup` to prepare the demo project
136-
- Build with `npm run build`
137-
- Run and deploy to your device or emulator with `npm run demo.android` or `npm run demo.ios`
135+
- Run `npm install` to prepare the project
136+
- Run and deploy to your device or emulator with `npm run android` or `npm run ios`
137+
- Build a ngPackagr version with `npm run build`
138138

139139
#### Known issues
140140

0 commit comments

Comments
 (0)