Skip to content

Commit

Permalink
Update the readme
Browse files Browse the repository at this point in the history
  • Loading branch information
w3nl committed Jul 1, 2020
1 parent d84bef9 commit 09a4d85
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 2 deletions.
15 changes: 14 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Logic gates package

Generate logic gates without thinking.
You can use this package if you need well tested logic gate checks.
e.g. if all options must be true or false, but don't must be a mix of true and false, you can use the xand gate.

[![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coveralls Status][coveralls-image]][coveralls-url]

Expand Down Expand Up @@ -36,7 +38,7 @@ Output a boolean:
true
```

Or the simple way:
Or use the short syntax:
```
import { and } from "@hckrnews/logic-gates";
Expand All @@ -59,6 +61,17 @@ All options:
- [XnandGate](https://en.wiktionary.org/wiki/XNAND)
- [NotGate](https://en.wikipedia.org/wiki/NOT_gate)

Short syntax:
- [and](https://en.wikipedia.org/wiki/AND_gate)
- [nand](https://en.wikipedia.org/wiki/NAND_gate)
- [or](https://en.wikipedia.org/wiki/OR_gate)
- [nor](https://en.wikipedia.org/wiki/NOR_gate)
- [xor](https://en.wikipedia.org/wiki/XOR_gate)
- [xnor](https://en.wikipedia.org/wiki/XNOR_gate)
- [xand](https://en.wiktionary.org/wiki/XAND)
- [xnand](https://en.wiktionary.org/wiki/XNAND)
- [not](https://en.wikipedia.org/wiki/NOT_gate)

## And gate

| Input 1 | Input 2 | Input 3 | Output |
Expand Down
2 changes: 1 addition & 1 deletion tests/unit/not.spec.js
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ const TestCases = [
],
[
[false, true, false, true],
[tue, false, true, false],
[true, false, true, false],
],
[
[false, true, true, false],
Expand Down

0 comments on commit 09a4d85

Please sign in to comment.