https://github.com/ebraminio/persiantools
Persian text library
https://github.com/ebraminio/persiantools
Last synced: 26 days ago
JSON representation
Persian text library
- Host: GitHub
- URL: https://github.com/ebraminio/persiantools
- Owner: ebraminio
- License: other
- Created: 2013-07-26T19:59:49.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2013-07-26T19:03:35.000Z (almost 12 years ago)
- Last Synced: 2025-03-13T01:41:14.221Z (2 months ago)
- Language: JavaScript
- Size: 41 KB
- Stars: 11
- Watchers: 4
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
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.