Skip to content

Commit c537e7f

Browse files
committed
format plugins markdown
1 parent 4c454ce commit c537e7f

File tree

1 file changed

+16
-8
lines changed

1 file changed

+16
-8
lines changed

plugins/README.md

+16-8
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@ Plugins allow you to modify instamancer's functionality and behavior while gathe
44

55
The following internal plugins are included with instamancer (but not enabled by default):
66

7-
|Plugin|Description|
8-
|------|-----------|
7+
|Plugin |Description |
8+
|----------|-------------------------------------------------------------------|
99
|LargeFirst|Increase the `first` parameter in API requests to ask for more data|
1010

1111
## Using plugins with the CLI
1212

1313
Example:
14-
```
14+
15+
```
1516
instamancer hashtag puppies -c1000 --plugin LargeFirst --plugin MyPlugin
1617
```
1718

@@ -24,25 +25,32 @@ Steps:
2425
1. Clone the instamancer repository
2526
2. Install instamancer's dependencies
2627
3. Install the plugin with npm / yarn
27-
4. Add the plugin to `plugins/plugins/index.ts`
28+
4. Add the plugin to `plugins/plugins/index.ts`
29+
2830
Example:
29-
```typescript
31+
32+
33+
``` typescript
3034
export { MyPlugin } from "myplugin";
3135
```
36+
3237
5. Install instamancer
3338
1. You can skip this step if you want to run the CLI from source
3439
6. Run the CLI with the plugin:
40+
3541

3642
Example:
37-
```
43+
44+
45+
```
3846
instamancer hashtag puppies -c100 --plugin MyPlugin
3947
```
4048

4149
## Using plugins with the module
4250

43-
Add the plugin to the `options`:
51+
Add the plugin to the `options` :
4452

45-
```typescript
53+
``` typescript
4654
import * as instamancer from ".";
4755

4856
const options: instamancer.IOptions = {

0 commit comments

Comments
 (0)