Skip to content

improvised Docs #21

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

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

improvised Docs #21

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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Space.js
# Space.js an amazing javascript library
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 THAT SHOULD BE CONSIDERED TO BE BETA VERSION OF THE SOFTWARE**
*Production use is not recommended at this point.*

## Usage

**Import the library**
**Importing the library**
```html
<head>
<script type="text/javascript" src="[jquery]"></script>
Expand Down Expand Up @@ -40,7 +40,7 @@ I would also **strongly** recommend using an inner-frame inside the space-frame,
</div>
```

### Custom duration
### Customising duration
If we want we can provide a custom duration for our frames with the data-duration attribute, which multiplies the default duration of the transition.

```html
Expand All @@ -62,7 +62,7 @@ Multiple values are supported!
<section class="space-frame" data-transition="rotate360 fadeOut slideInLeft">...</section>
```

### Custom entry and exit
### Customised entry and exit
If we really want to get into detail, we can provide how we wish the frame to enter (first half of the frame duration) and exit (second half).

```html
Expand Down