Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Bersam/persiantools

Persian text library
https://github.com/Bersam/persiantools

Last synced: 3 months ago
JSON representation

Persian text library

Awesome Lists containing this project

README

        

# persiantools

Persian text library

## Getting Started
### On the server
Install the module with: `npm install persiantools`

```javascript
var persiantools = require('persiantools');
persiantools.awesome(); // "awesome"
```

### In the browser
Download the [production version][min] or the [development version][max].

[min]: https://raw.github.com/ebraminio/persiantools/master/dist/persiantools.min.js
[max]: https://raw.github.com/ebraminio/persiantools/master/dist/persiantools.js

In your web page:

```html

awesome(); // "awesome"

```

In your code, you can attach persiantools's methods to any object.

```html

var exports = Bocoup.utils;

Bocoup.utils.awesome(); // "awesome"

```

## Documentation
_(Coming soon)_

## Examples
_(Coming soon)_

## Contributing
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using [Grunt](http://gruntjs.com/).

_Also, please don't edit files in the "dist" subdirectory as they are generated via Grunt. You'll find source code in the "lib" subdirectory!_

## Release History
_(Nothing yet)_

## License
Copyright (c) 2013 Ebrahim Byagowi
Licensed under the MIT license.