Skip to content

Commit

Permalink
Update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
runegan committed Jun 14, 2017
1 parent bfb6ce6 commit 0b51db1
Showing 1 changed file with 37 additions and 49 deletions.
86 changes: 37 additions & 49 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,33 +9,58 @@ Requirements
Adobe After Effects
ExtendScript Toolkit or other text editor

Download
--------
[The latest version of AEQuery can be found in the downloads section of this repository](https://bitbucket.org/motiondesign/aequery/downloads)
Download/install
----------------

```bash
npm install aequery
```

If you are not using npm, you can download the latest version [here](https://bitbucket.org/motiondesign/aequery/downloads)

Then you can include it in your script

Import into your script
```javascript
#include 'path/to/aequery.js'

// Disable all Camera lens blur effects in active comp
aeq( 'activecomp effect[MatchName="ADBE Camera Lens Blur"]' ).attr( 'enabled', false )
```

or, if you are using browserify/typescript or similar:

```javascript
var aeq = require( 'aequery' )

var comp = aeq.getActiveComp()

if (comp) {
aeq.forEachLayer( function ( layer ) {
// Do something with layer
})
}
```

Documentation
-------------
[For documentation, visit aequery.aenhancers.com](http://aequery.aenhancers.com)


How to build it yourself
------------------------
Development
-----------

Make sure you have [node](https://nodejs.org) and [npm](https://www.npmjs.com) installed

Install gulp
```bash
sudo npm install -g gulp
```

Clone repository and enter the directory
```bash
# Clone the repository and enter the directory
git clone https://bitbucket.org/motiondesign/aequery.git
cd aequery
```

Install npm dependencies
```bash
# Install npm dependencies
npm install
```

Expand All @@ -45,42 +70,5 @@ gulp # Builds it to the relevant places in the ScriptUI Folder
gulp watch # Will monitor it and rebuild it real quick if anything changes
```

Import into your script
```javascript
#include "path/to/aeq.js"
```

# Contributing
Want to add something in AEQuery?

Look in the file tree to see if there is a place where it may fit.

If necessary, create a new file. The basic file structure is:
```javascript
var aeq = (function (aeq) {
aeq.extend({
yourCodeHere: function() {

}
});
return aeq;
}(aeq || {}));
```
If you want to create a submodule, the structure is:
```javascript
var aeq = (function (aeq) {
aeq.yourModule = {
toString: function() {
return "[object aeq.yourModule]";
},

// Function for extending the object using objects
extend: aeq.extend,

code: function() {

}
}
return aeq;
}(aeq || {}));
```
Pull requests, [bug reports and feature requests](https://bitbucket.org/motiondesign/aequery/issues) are welcome!

0 comments on commit 0b51db1

Please sign in to comment.