Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
IonicaBizau committed Apr 26, 2016
1 parent bf0475b commit fb6ef07
Show file tree
Hide file tree
Showing 3 changed files with 37 additions and 9 deletions.
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@ Contributions are more than welcome!

Thanks! :sweat_smile:



[1]: https://github.com/IonicaBizau/indento/issues

[2]: https://github.com/IonicaBizau/code-style
[2]: https://github.com/IonicaBizau/code-style
15 changes: 15 additions & 0 deletions DOCUMENTATION.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
## Documentation

You can see below the API reference of this module.

### `indento(input, width, char)`
Indents the input string.

#### Params
- **String** `input`: The input string.
- **Number** `width`: The indent width.
- **String** `char`: The character to use for indentation (default: `" "`).

#### Return
- **String** The indented string.

27 changes: 19 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,18 @@

# indento [![PayPal](https://img.shields.io/badge/%24-paypal-f39c12.svg)][paypal-donations] [![Version](https://img.shields.io/npm/v/indento.svg)](https://www.npmjs.com/package/indento) [![Downloads](https://img.shields.io/npm/dt/indento.svg)](https://www.npmjs.com/package/indento) [![Get help on Codementor](https://cdn.codementor.io/badges/get_help_github.svg)](https://www.codementor.io/johnnyb?utm_source=github&utm_medium=button&utm_term=johnnyb&utm_campaign=github)

> Indent strings.
## Installation
## :cloud: Installation

```sh
$ npm i --save indento
```

## Example

## :clipboard: Example



```js
const indento = require("indento");
Expand All @@ -27,7 +31,8 @@ console.log(indento("Hello\nPluto", 2, "a"));
// aaPluto
```

## Documentation
## :memo: Documentation


### `indento(input, width, char)`
Indents the input string.
Expand All @@ -40,15 +45,21 @@ Indents the input string.
#### Return
- **String** The indented string.

## How to contribute


## :yum: How to contribute
Have an idea? Found a bug? See [how to contribute][contributing].

## Where is this library used?
## :dizzy: Where is this library used?
If you are using this library in one of your projects, add it in this list. :sparkles:

- [`emoji-logger`](https://github.com/IonicaBizau/emoji-logger#readme)

## License
- [`bgm`](https://github.com/egoist/bgm#readme) (by EGOIST)—Display bangumi list in CLI.
- [`emoji-logger`](https://github.com/IonicaBizau/emoji-logger#readme)—Logging library based on flat colors and Emoji.
- [`testen`](https://github.com/egoist/testen#readme) (by EGOIST)—Run tests for multiple versions of Node.js in local env.
- [`tilda`](https://github.com/IonicaBizau/tilda)—Tiny module for building command line tools.

## :scroll: License

[MIT][license] © [Ionică Bizău][website]

Expand All @@ -58,4 +69,4 @@ If you are using this library in one of your projects, add it in this list. :spa
[license]: http://showalicense.com/?fullname=Ionic%C4%83%20Biz%C4%83u%20%3Cbizauionica%40gmail.com%3E%20(http%3A%2F%2Fionicabizau.net)&year=2015#license-mit
[website]: http://ionicabizau.net
[contributing]: /CONTRIBUTING.md
[docs]: /DOCUMENTATION.md
[docs]: /DOCUMENTATION.md

0 comments on commit fb6ef07

Please sign in to comment.