Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improved Docs #28

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improved Docs #28

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ A HTML-driven JavaScript-library for narrative 3D-scrolling.

See the demos [here](http://www.slashie.org/space.js/)

**NOTE THAT SHOULD BE CONSIDERED TO BE BETA SOFTWARE**
**NOTE: IT SHOULD BE CONSIDERED A BETA SOFTWARE**
*Production use is not recommended at this point.*

## Usage
Expand Down Expand Up @@ -50,7 +50,7 @@ If we want we can provide a custom duration for our frames with the data-duratio


### Options
Space.js has a default default transition - which is to enter by fading in and exit by scaling up and fading out. We can also provide a custom transition override to the library from predefined transitions. (We can also create our own transitions from scratch, but we'll get to that later.)
Space.js has a default transition - which is to enter by fading in and exit by scaling up and fading out. We can also provide a custom transition override to the library from predefined transitions. (We can also create our own transitions from scratch, but we'll get to that later.)

```html
<section class="space-frame" data-transition="rotate360">...</section>
Expand All @@ -69,7 +69,7 @@ If we really want to get into detail, we can provide how we wish the frame to en
<section class="space-frame" data-enter="fadeIn" data-exit="fadeOut zoomOut">...</section>
```

## What a complete frame could look like
## What a complete frame will look like
```html
<div class="space-frame" data-enter="fadeIn" data-exit="zoomOut fadeOut" data-duration="1.3">
<section class="space-inner-frame">
Expand Down Expand Up @@ -103,7 +103,7 @@ You can add your own transitions with the ```addTransitions`` method. Make sure
```

### Currently supported transitions
Note that these might come to change during the beta-phase of the library.
Note that these might change during the beta-phase of the library.

- scaleIn
- fadeIn
Expand Down