Skip to content

Commit

Permalink
updated the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
roncodes committed Dec 13, 2023
1 parent d39354f commit 72c588c
Showing 1 changed file with 64 additions and 13 deletions.
77 changes: 64 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,83 @@
# @fleetbase/ember-accounting

[Short description of the addon.]
This is a fork of [ember-cli-accounting](https://github.com/milindalvares/ember-cli-accounting) which was a port of the great [accounting.js](https://github.com/openexchangerates/accounting.js) library to
ES6 modules that integrates seamlessly with ember-cli and the Fleetbase ecosystem.

## Installation

## Compatibility
Just add like any other ember-cli addon:

* Ember.js v4.8 or above
* Ember CLI v4.8 or above
* Node.js v18 or above
```bash
npm install @fleetbase/ember-accounting
```

## Ember compatiblity

## Installation
Compatible with Ember version 4.0 and above

## Usage

### Accounting functions

You no longer need to access the global accounting, you can import only what you need:

```js
import formatMoney from '@fleetbase/ember-accounting/format-money'
```
ember install @fleetbase/ember-accounting

Although you can import everything as expected:

```js
import accounting from '@fleetbase/ember-accounting'
```

### Handlebars helpers

## Usage
This addon also registers 2 handy helpers in your application: `format-number` and `format-money`.

[Longer description of how to use the addon in apps.]
You can set options using bound or unbound options like this:

```hbs
{{format-money price symbol=selectedCurrency format="%v %s"}} <!-- "123.45 £" -->
```

Any option not set will have the usual default value:

```hbs
{{format-number "1234.567" precision=2}} <!-- "1,234.57" -->
```

### Config default options

You can use an initializer to set some default values at initializations and avoid having to
repeat over and over the options in the helpers.

Use something like this:
```js
// app/initializers/accounting.js
import { currency, number } from '@fleetbase/ember-accounting/settings';

export default {
name: 'accounting.js',
initialize: function() {
currency.symbol = "";
number.decimal = ",";
number.thousand = ".";
}
};
```

## Contributing
## Differences with accounting.js

See the [Contributing](CONTRIBUTING.md) guide for details.
Although this is almost a 1:1 port of accountant.js, there is a few differences:

* Each function of accountant.js lives in its own module, so you can only import those functions you want to use.
* Removed some polyfills for `Array.isArray`, `Array.prototype.map` and `Object.prototype.toString`.
They are not required in modern browsers, and ember.js (unless you opt-out with `EXTEND_PROTOTYPES = false`) already provides polyfills for those functions.
* More tests than the original.
* Enforced jshint. Cleaner code.

## License
## Documentation

This project is licensed under the [MIT License](LICENSE.md).
This library does not make any change in the public api of accounting.js, so you can read the official
documentation [here](http://openexchangerates.github.io/accounting.js/)

0 comments on commit 72c588c

Please sign in to comment.