Skip to content

Commit

Permalink
Update readme (naver#375)
Browse files Browse the repository at this point in the history
docs(README): Add demo link

Ref naver#335
  • Loading branch information
mixed authored Sep 21, 2016
1 parent ae656e9 commit d6af3f4
Show file tree
Hide file tree
Showing 2 changed files with 23 additions and 11 deletions.
18 changes: 12 additions & 6 deletions README-ko.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,15 @@ egjs는 jQuery를 기반으로 하는 JavaScript 라이브러리로, UI 인터

egjs가 제공하는 컴포넌트는 다음과 같다.

* eg: egjs에서 사용하는 기본 유틸리티 모듈. egjs의 기본 네임스페이스다.
* eg: egjs에서 사용하는 기본 유틸리티 모듈. egjs의 기본 네임스페이스다.
- [API 문서](http://naver.github.io/egjs/latest/doc/eg.html)
- [모듈 사용 예](http://naver.github.io/egjs/demo/eg/)
* eg.Class: 객체지향 프로그래밍 방식으로 클래스를 개발할 수 있게 하는 모듈
- [API 문서](http://naver.github.io/egjs/latest/doc/eg.Class.html)
- [모듈 사용 예](http://naver.github.io/egjs/demo/class/)
* eg.Component: 모듈의 이벤트와 옵션을 관리할 수 있게 하는 클래스
- [API 문서](http://naver.github.io/egjs/latest/doc/eg.Component.html)
- [모듈 사용 예](http://naver.github.io/egjs/demo/component/)
* eg.MovableCoord: 사용자의 동작을 가상 좌표계의 논리적 좌표로 변경하는 모듈
- [API 문서](http://naver.github.io/egjs/latest/doc/eg.MovableCoord.html)
- [모듈 사용 예](http://naver.github.io/egjs/demo/movableCoord/), [모듈 사용 예(CodePen)](http://codepen.io/collection/AKpkGW/)
Expand All @@ -27,7 +30,7 @@ egjs가 제공하는 컴포넌트는 다음과 같다.
- [모듈 사용 예](http://naver.github.io/egjs/demo/flicking/), [모듈 사용 예(CodePen)](http://codepen.io/collection/ArxyLK/)
* eg.Visible: 엘리먼트가 기준 엘리먼트나 뷰포트 안에 보이는지 확인하는 모듈
- [API 문서](http://naver.github.io/egjs/latest/doc/eg.Visible.html)
- [모듈 사용 예(CodePen)](http://codepen.io/collection/Ayrabj/)
- [모듈 사용 예](http://naver.github.io/egjs/demo/visible/), [모듈 사용 예(CodePen)](http://codepen.io/collection/Ayrabj/)
* eg.infiniteGrid: 콘텐츠가 있는 카드 엘리먼트를 그리드 레이아웃에 무한으로 배치하는 모듈
- [API 문서](http://naver.github.io/egjs/latest/doc/eg.InfiniteGrid.html)
- [모듈 사용 예](http://naver.github.io/egjs/demo/infiniteGrid/), [모듈 사용 예(CodePen)](http://codepen.io/collection/DPYEww/)
Expand All @@ -42,24 +45,27 @@ egjs의 jQuery 확장 메서드는 다음과 같다.

* persist() 메서드: 웹 페이지의 현재 상태를 키에 JSON 형식으로 저장한다.
- [API 문서](http://naver.github.io/egjs/latest/doc/jQuery.html#persist)
- [메서드 사용 예(CodePen)](http://codepen.io/collection/XOLpog/)
- [메서드 사용 예](http://naver.github.io/egjs/demo/persist/), [메서드 사용 예(CodePen)](http://codepen.io/collection/XOLpog/)
* prefixCss() 메서드: CSS 속성의 제조사 접두어(vendor prefix)를 지원하지 않는 일부 jQuery 버전을 사용할 때 제조사 접두어를 지원할 수 있게 한다.
- [API 문서](http://naver.github.io/egjs/latest/doc/jQuery.html#persist)
- [메서드 사용 예](http://naver.github.io/egjs/demo/cssPrefix/)
* animate() 메서드: jQuery의 animate() 메서드를 확장한 메서드. CSS의 transform 속성과 3D 가속을 사용할 수 있다.
- [API 문서](http://naver.github.io/egjs/latest/doc/jQuery.html#animate)
- [메서드 사용 예](http://naver.github.io/egjs/demo/transform/)
* pause() 메서드, resume() 메서드: jQuery의 animate() 메서드로 실행한 애니메이션을 일시 정지하고 다시 실행한다.
- [API 문서](http://naver.github.io/egjs/latest/doc/jQuery.html#pause)
- [메서드 사용 예(CodePen)](http://codepen.io/collection/XOEpOw)
- [메서드 사용 예](http://naver.github.io/egjs/demo/pauseResume/), [메서드 사용 예(CodePen)](http://codepen.io/collection/XOEpOw)

#### 이벤트

egjs의 jQuery 확장 이벤트는 다음과 같다.

* rotate: 모바일 기기의 회전을 감지하는 이벤트
- [API 문서](http://naver.github.io/egjs/latest/doc/jQuery.html#event:rotate)
- [이벤트 사용 예(CodePen)](http://codepen.io/collection/nLYYqP/)
- [이벤트 사용 예](http://naver.github.io/egjs/demo/rotate/), [이벤트 사용 예(CodePen)](http://codepen.io/collection/nLYYqP/)
* scrollend: 스크롤의 마지막 시점을 감지하는 이벤트
- [API 문서](http://naver.github.io/egjs/latest/doc/jQuery.html#event:scrollEnd)
- [이벤트 사용 예(CodePen)](http://codepen.io/collection/Dxeemo/)
- [이벤트 사용 예](http://naver.github.io/egjs/demo/scrollEnd/), [이벤트 사용 예(CodePen)](http://codepen.io/collection/Dxeemo/)

## 다운로드 및 설치

Expand Down
16 changes: 11 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,13 @@ The following is a list of egjs components.

* eg: As a default namespace, it is a collection of base utilities for egjs, which is used in diverse components.
- [API Documentation](http://naver.github.io/egjs/latest/doc/eg.html)
- [Usage Examples](http://naver.github.io/egjs/demo/eg/)
* eg.Class: A module that enables developing classes in object-oriented programming style.
- [API Documentation](http://naver.github.io/egjs/latest/doc/eg.Class.html)
- [Usage Examples](http://naver.github.io/egjs/demo/class/)
* eg.Component: A base class utility that manages events and options in modules.
- [API Documentation](http://naver.github.io/egjs/latest/doc/eg.Component.html)
- [Usage Examples](http://naver.github.io/egjs/demo/component/)
* eg.MovableCoord: A module that transforms user coordinates into logical coordinates in a virtual coordinate system.
- [API Documentation](http://naver.github.io/egjs/latest/doc/eg.MovableCoord.html)
- [Usage Examples](http://naver.github.io/egjs/demo/movableCoord/), [Usage Examples (CodePen)](http://codepen.io/collection/AKpkGW/)
Expand All @@ -27,7 +30,7 @@ The following is a list of egjs components.
- [Usage Examples](http://naver.github.io/egjs/demo/flicking/), [Usage Examples (CodePen)](http://codepen.io/collection/ArxyLK/)
* eg.Visible: A module that checks if an element is visible in the base element or viewport.
- [API Documentation](http://naver.github.io/egjs/latest/doc/eg.Visible.html)
- [Usage Examples (CodePen)](http://codepen.io/collection/Ayrabj/)
- [Usage Examples](http://naver.github.io/egjs/demo/visible/), [Usage Examples (CodePen)](http://codepen.io/collection/Ayrabj/)
* eg.infiniteGrid: A module that arranges infinite card elements including content on a grid.
- [API Documentation](http://naver.github.io/egjs/latest/doc/eg.InfiniteGrid.html)
- [Usage Examples](http://naver.github.io/egjs/demo/infiniteGrid/), [Usage Examples (CodePen)](http://codepen.io/collection/DPYEww/)
Expand All @@ -42,24 +45,27 @@ The following is a list of methods extended from jQuery.

* persist() method: Stores the current state of a webpage into a key in JSON.
- [API Documentation](http://naver.github.io/egjs/latest/doc/jQuery.html#persist)
- [Usage Examples (CodePen)](http://codepen.io/collection/XOLpog/)
- [Usage Examples](http://naver.github.io/egjs/demo/persist/), [Usage Examples (CodePen)](http://codepen.io/collection/XOLpog/)
* prefixCss() method: Enables to add CSS vendor prefixes when you use jQuery that does not support them.
- [API Documentation](http://naver.github.io/egjs/latest/doc/jQuery.html#persist)
- [Usage Examples](http://naver.github.io/egjs/demo/cssPrefix/)
* animate() method: A method extended from the jQuery animate() method. It supports CSS transform property and 3D acceleration.
- [API Documentation](http://naver.github.io/egjs/latest/doc/jQuery.html#animate)
- [Usage Examples](http://naver.github.io/egjs/demo/transform/)
* pause() and resume() methods: Pauses and resumes animation executed by the jQuery animate() method.
- [API Documentation](http://naver.github.io/egjs/latest/doc/jQuery.html#pause)
- [Usage Examples (CodePen)](http://codepen.io/collection/XOEpOw)
- [Usage Examples](http://naver.github.io/egjs/demo/pauseResume/), [Usage Examples (CodePen)](http://codepen.io/collection/XOEpOw)

#### Events

The following is a list of events extended from jQuery.

* rotate: An event that detects the orientation of the mobile device.
- [API Documentation](http://naver.github.io/egjs/latest/doc/jQuery.html#event:rotate)
- [Usage Examples (CodePen)](http://codepen.io/collection/nLYYqP/)
- [Usage Examples](http://naver.github.io/egjs/demo/rotate/), [Usage Examples (CodePen)](http://codepen.io/collection/nLYYqP/)
* scrollend: An event that detects the scrolling to bottom of the page.
- [API Documtation](http://naver.github.io/egjs/latest/doc/jQuery.html#event:scrollEnd)
- [Usage Examples (CodePen)](http://codepen.io/collection/Dxeemo/)
- [Usage Examples](http://naver.github.io/egjs/demo/scrollEnd/), [Usage Examples (CodePen)](http://codepen.io/collection/Dxeemo/)

## Downloads and Installation

Expand Down

0 comments on commit d6af3f4

Please sign in to comment.