Skip to content

Commit 0b51db1

Browse files
committed
Update Readme
1 parent bfb6ce6 commit 0b51db1

File tree

1 file changed

+37
-49
lines changed

1 file changed

+37
-49
lines changed

README.md

Lines changed: 37 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -9,33 +9,58 @@ Requirements
99
Adobe After Effects
1010
ExtendScript Toolkit or other text editor
1111

12-
Download
13-
--------
14-
[The latest version of AEQuery can be found in the downloads section of this repository](https://bitbucket.org/motiondesign/aequery/downloads)
12+
Download/install
13+
----------------
14+
15+
```bash
16+
npm install aequery
17+
```
18+
19+
If you are not using npm, you can download the latest version [here](https://bitbucket.org/motiondesign/aequery/downloads)
20+
21+
Then you can include it in your script
22+
23+
Import into your script
24+
```javascript
25+
#include 'path/to/aequery.js'
26+
27+
// Disable all Camera lens blur effects in active comp
28+
aeq( 'activecomp effect[MatchName="ADBE Camera Lens Blur"]' ).attr( 'enabled', false )
29+
```
30+
31+
or, if you are using browserify/typescript or similar:
32+
33+
```javascript
34+
var aeq = require( 'aequery' )
35+
36+
var comp = aeq.getActiveComp()
37+
38+
if (comp) {
39+
aeq.forEachLayer( function ( layer ) {
40+
// Do something with layer
41+
})
42+
}
43+
```
1544

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

2049

21-
How to build it yourself
22-
------------------------
50+
Development
51+
-----------
2352

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

2655
Install gulp
2756
```bash
2857
sudo npm install -g gulp
29-
```
3058

31-
Clone repository and enter the directory
32-
```bash
59+
# Clone the repository and enter the directory
3360
git clone https://bitbucket.org/motiondesign/aequery.git
3461
cd aequery
35-
```
3662

37-
Install npm dependencies
38-
```bash
63+
# Install npm dependencies
3964
npm install
4065
```
4166

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

48-
Import into your script
49-
```javascript
50-
#include "path/to/aeq.js"
51-
```
52-
5373
# Contributing
54-
Want to add something in AEQuery?
55-
56-
Look in the file tree to see if there is a place where it may fit.
57-
58-
If necessary, create a new file. The basic file structure is:
59-
```javascript
60-
var aeq = (function (aeq) {
61-
aeq.extend({
62-
yourCodeHere: function() {
63-
64-
}
65-
});
66-
return aeq;
67-
}(aeq || {}));
68-
```
69-
If you want to create a submodule, the structure is:
70-
```javascript
71-
var aeq = (function (aeq) {
72-
aeq.yourModule = {
73-
toString: function() {
74-
return "[object aeq.yourModule]";
75-
},
76-
77-
// Function for extending the object using objects
78-
extend: aeq.extend,
79-
80-
code: function() {
81-
82-
}
83-
}
84-
return aeq;
85-
}(aeq || {}));
86-
```
74+
Pull requests, [bug reports and feature requests](https://bitbucket.org/motiondesign/aequery/issues) are welcome!

0 commit comments

Comments
 (0)