Skip to content

Commit 9af54cc

Browse files
committed
- Improving adding a few aesthetics bits
1 parent db051cc commit 9af54cc

File tree

1 file changed

+9
-12
lines changed

1 file changed

+9
-12
lines changed

README.md

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
# fullPage.js
22
![preview](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/intro.png)
33
![compatibility](https://raw.github.com/alvarotrigo/fullPage.js/master/examples/imgs/compatible.gif?v=2)
4-
<p align="center">
5-
<i>The most popular and complete slider of its kind</i><br>
6-
</p>
74

85
<p align="center">
96
<a href="https://github.com/alvarotrigo/fullPage.js"><img src="https://raw.githubusercontent.com/alvarotrigo/fullPage.js/dev/examples/imgs/en-language.png" /></a><a href="https://github.com/alvarotrigo/fullPage.js/blob/dev/README_SPANISH.md#fullpagejs"><img src="https://raw.githubusercontent.com/alvarotrigo/fullPage.js/dev/examples/imgs/es-language-inactive.png" /></a>
@@ -13,7 +10,7 @@
1310
[![PayPal Donate](https://img.shields.io/badge/donate-PayPal.me-ff69b4.svg)](https://www.paypal.me/alvarotrigo/9.95)
1411
&nbsp;&nbsp; **|**&nbsp;&nbsp; *7Kb gziped* &nbsp;&nbsp;**|**&nbsp;&nbsp; *Created by [@imac2](https://twitter.com/imac2)*
1512

16-
A simple and easy to use plugin to create fullscreen scrolling websites (also known as single page websites or onepage sites).
13+
A simple and easy to use libary to create fullscreen scrolling websites (also known as single page websites or onepage sites).
1714
It allows the creation of fullscreen scrolling websites, as well as adding some landscape sliders inside the sections of the site.
1815

1916
- [Live demo](http://alvarotrigo.com/fullPage/)
@@ -24,7 +21,7 @@ It allows the creation of fullscreen scrolling websites, as well as adding some
2421
Invite me to a coffee
2522
[![Donate](https://www.paypalobjects.com/en_US/GB/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=BEK5JQCQMED4J&lc=GB&item_name=fullPage%2ejs&currency_code=USD&bn=PP%2dDonationsBF%3abtn_donateCC_LG%2egif%3aNonHosted)
2623

27-
Customizations of the plugin and urgent changes are available upon request for some reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
24+
Customizations of the library and urgent changes are available upon request for some reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
2825

2926
Would you like to have a website using fullpage.js functionality but you don't know how to use it? I can do it for you for a reasonable price. <a href="http://alvarotrigo.com/#contact-page">Contact me</a>.
3027

@@ -51,7 +48,7 @@ Would you like to have a website using fullpage.js functionality but you don't k
5148

5249
## Introduction
5350
Suggestion are more than welcome, not only for feature requests but also for coding style improvements.
54-
Let's make this a great plugin to make people's lives easier!
51+
Let's make this a great library to make people's lives easier!
5552

5653
## Compatibility
5754
fullPage.js is fully functional on all modern browsers, as well as some old ones such as Internet Explorer 8, 9, Opera 12, etc.
@@ -92,7 +89,7 @@ npm install fullpage.js
9289
<script src="vendors/jquery.easings.min.js"></script>
9390

9491

95-
<!-- This following line is only necessary in the case of using the plugin option `scrollOverflow:true` -->
92+
<!-- This following line is only necessary in the case of using the option `scrollOverflow:true` -->
9693
<script type="text/javascript" src="vendors/scrolloverflow.min.js"></script>
9794

9895
<script type="text/javascript" src="jquery.fullPage.js"></script>
@@ -134,7 +131,7 @@ In order to create a landscape slider within a section, each slide will be defin
134131
You can see a fully working example of the HTML structure in the [`demoPage.html` file](https://github.com/alvarotrigo/fullPage.js/blob/master/examples/demoPage.html).
135132

136133
###Initialization
137-
All you need to do is call the plugin inside a `$(document).ready` function:
134+
All you need to do is call fullPage.js inside a `$(document).ready` function:
138135

139136
```javascript
140137
$(document).ready(function() {
@@ -257,7 +254,7 @@ Note that section anchors can also be defined in the same way, by using the `dat
257254

258255
### Creating smaller or bigger sections
259256
[Demo](http://codepen.io/alvarotrigo/pen/BKjRYm) fullPage.js provides a way to remove the full height restriction from its sections and slides. It is possible to create sections which height is smaller or bigger than the viewport. This is ideal for footers.
260-
It is important to realise that it doesn't make sense to have all of your sections using this feature. If there is more than one section in the initial load of the site, the plugin won't scroll at all to see the next one as it will be already in the viewport.
257+
It is important to realise that it doesn't make sense to have all of your sections using this feature. If there is more than one section in the initial load of the site, fullPage.js won't scroll at all to see the next one as it will be already in the viewport.
261258

262259
To create smaller sections just use the class `fp-auto-height` in the section you want to apply it. It will then take the height defined by your section/slide content.
263260

@@ -277,7 +274,7 @@ Fullpage.js adds multiple classes in different elements to keep a record of the
277274
- A class of the form `fp-viewing-SECTION-SLIDE` is added to the `body` element of the site. (eg: [`fp-viewing-secondPage-0`](http://alvarotrigo.com/fullPage/#secondPage)) The `SECTION` and `SLIDE` parts will be the anchors (or indexes if no anchor is provided) of the current section and slide.
278275
- `fp-responsive` is added to the `body` element when the entering in the responsive mode
279276
- `fp-enabled` is added to the `html` element when fullpage.js is enabled. (and removed when destroyed).
280-
- `fp-destroyed` is added to the fullpage.js container when the plugin is destroyed.
277+
- `fp-destroyed` is added to the fullpage.js container when fullPage.js is destroyed.
281278
- `fp-enabled` is added to the `html` element once the libary is initalized.
282279

283280
###Lazy Loading
@@ -337,7 +334,7 @@ Then you will be able to use and configure them as explained in [options](https:
337334

338335
- `controlArrows`: (default `true`) Determines whether to use control arrows for the slides to move right or left.
339336

340-
- `verticalCentered`: (default `true`) Vertically centering of the content within sections. When set to `true`, your content will be wrapped by the plugin. Consider using delegation or load your other scripts in the `afterRender` callback.
337+
- `verticalCentered`: (default `true`) Vertically centering of the content within sections. When set to `true`, your content will be wrapped by the library. Consider using delegation or load your other scripts in the `afterRender` callback.
341338

342339
- `scrollingSpeed`: (default `700`) Speed in milliseconds for the scrolling transitions.
343340

@@ -352,7 +349,7 @@ $('#fullpage').fullpage({
352349
- `anchors`: (default `[]`) Defines the anchor links (#example) to be shown on the URL for each section. Anchors value should be unique. The position of the anchors in the array will define to which sections the anchor is applied. (second position for second section and so on). Using anchors forward and backward navigation will also be possible through the browser. This option also allows users to bookmark a specific section or slide. **Be careful!** anchors can not have the same value as any ID element on the site (or NAME element for IE).
353350
Now anchors can be defined directly in the HTML structure by using the attribute `data-anchor` as explained here.
354351

355-
- `lockAnchors`: (default `false`) Determines whether anchors in the URL will have any effect at all in the plugin. You can still using anchors internally for your own functions and callbacks, but they won't have any effect in the scrolling of the site. Useful if you want to combine fullPage.js with other plugins using anchor in the URL.
352+
- `lockAnchors`: (default `false`) Determines whether anchors in the URL will have any effect at all in the library. You can still using anchors internally for your own functions and callbacks, but they won't have any effect in the scrolling of the site. Useful if you want to combine fullPage.js with other plugins using anchor in the URL.
356353

357354
**Important** It is helpful to understand that the values in the `anchors` option array correlate directly to the element with the class of `.section` by it's position in the markup.
358355

0 commit comments

Comments
 (0)