Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
guiferpa authored Oct 8, 2018
1 parent 787399f commit c83ec7b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# koala

### Whats's it?
**koala** is a CLI that join separate files generating only one file as a bundler. Nowadays already exists others bundlers more complete like the [Webpack](https://github.com/webpack/webpack) but the idea of **koala** is to be most simple and generic.
### What's it?
**koala** is a CLI that join separate files generating only one file as a bundler. Nowadays, others bundlers already exist, they are more complete like [Webpack](https://github.com/webpack/webpack), but the idea of koala is to be simpler and generic"

### Get started
**koala** need that you input an entrypoint to itself work and the entrypoint is just a file that **koala** will be to read like a hub to call others files, follow the sample of one entry file named as `./entry.js`.
**koala** needs that you input an entrypoint to itself work and the entrypoint is just a file that **koala** will read like a hub to call others files, follow the sample of one entry file named as `./entry.js`.
```js
'use strict';

Expand All @@ -13,18 +13,18 @@ include lib/hello.js
hello("Koala");
```

The entry file above is used to find out the targets that is just the line of entry file prefixed with a tag, see the example below where the tag is named as `include`.
The entry file above is used to find out the targets that is just the line of entry file prefixed with a tag, see the example below, where the tag is named as `include`.
```js
include lib/hello.js
```
Now look the external file at `./lib/hello` where the koala named it as library, follow the sample below.
Now, look the external file at `./lib/hello` where the koala named it as library, follow the sample below.

```js
function hello(name) {
console.log(`Hello, ${name}`);
}
```
Now look the output file at `./bin/out.js` and execute, this example execute the **koala** and [node.js](https://github.com/nodejs/node) together.
Now, look the output file at `./bin/out.js` and execute, this example execute the **koala** and [node.js](https://github.com/nodejs/node) together.
```js
'use strict';

Expand Down

0 comments on commit c83ec7b

Please sign in to comment.