Skip to content

Commit

Permalink
Fix the ci readme generator
Browse files Browse the repository at this point in the history
  • Loading branch information
omid committed Nov 11, 2022
1 parent f72310b commit ee6d6a3
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 82 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/update_readme.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:
- name: Install Cargo readme
run: cargo install cargo-readme
- name: Run Cargo readme
run: cargo readme --no-title --no-license > README.md
run: cd formula && cargo readme --no-title --no-license > ../README.md
- name: Commit the changes
uses: stefanzweifel/git-auto-commit-action@v4
with:
Expand Down
34 changes: 25 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
[![Crates.io](https://img.shields.io/crates/v/formula.svg)](https://crates.io/crates/formula)
[![Crates.io](https://img.shields.io/crates/v/formula.svg?style=flat)](https://crates.io/crates/formula)
[![npm](https://img.shields.io/npm/v/formula-wasm.svg?style=flat)](https://npmjs.com/package/formula-wasm)
[![Workflow Status](https://github.com/omid/formula/workflows/ci/badge.svg)](https://github.com/omid/formula/actions?query=workflow%3A%22ci%22)

<h1 align="center"><em>Formula</em></h1>
Expand All @@ -7,7 +8,7 @@
A parser and evaluator of spreadsheet-like formulas
</h3>

Formula is in its early stages, so it's better to be used cautiously.
Formula is in its early stages and is not ready for production use.

So far we have the following features:

Expand All @@ -18,7 +19,9 @@ So far we have the following features:
- 2 web functions
- plus all arithmetic and comparison operators

### Installation and usage
#### Installation and usage

##### Rust

Add this library to your project with `cargo add formula` or add `formula = "*"` to your `Cargo.toml` file.

Expand All @@ -35,22 +38,35 @@ fn main() -> Result<()> {
}
```

### What we do not support, yet:
##### JavaScript

Add this library to your project with `npm install formula-wasm` or add `formula-wasm` to your `package.json` file.

Use it similar to the following code:

```js
import { parse } from 'formula-wasm';

const value = parse('=UPPER(TRIM(" Hello "))');
console.assert(value, "HELLO");
```

#### What we do not support, yet:

- Support of functions are so limited at the moment, but we would like to add more of them, like Excel functions, Google Sheets functions, and so on
- At the moment, we don't support table data, so you need to pass values to the formula as arguments by yourself
- We don't support all existing functions in the world, but we would like to add more of them, like Excel functions, Google Sheets functions, and so on
- At the moment, we don't support table data. It means you need to extract table data and pass theirs values to this library
- We do not support simple formulas like `1+1` or as argument like `AND(1>3, 1<3)` or `SUM(2-1, 2)`. Instead, you can use our `F.` functions like `AND(F.GT(1, 3), F.LT(1, 3))` or `SUM(F.SUB(2, 1), 2)`
- We still do not support parentheses to change the order of operations, but you can use our `F.` functions. So for example instead of `2*(1+1)`, you should use `F.MUL(2, F.ADD(1, 1))`

### Contributing
#### Contributing

We would love to have your contribution! Please read our [contributing guidelines](CONTRIBUTING.md) to get started.

### Inspired by
#### Inspired by

- [formulajs](https://github.com/formulajs/formulajs)
- [hyperformula](https://github.com/handsontable/hyperformula)

### License
#### License

This project is licensed under the MIT license. See the [LICENSE](LICENSE.md) file for more info.
72 changes: 0 additions & 72 deletions formula/README.md

This file was deleted.

1 change: 1 addition & 0 deletions formula/README.md

0 comments on commit ee6d6a3

Please sign in to comment.