Skip to content

Commit

Permalink
Create README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lordanubi authored Mar 1, 2021
1 parent 4fc33be commit 0105dea
Showing 1 changed file with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
# Futuri: a React SVG Animated Pattern Maker

Futuri is an SVG Pattern Maker made from people for the people.
It gives you the possibility to make infinite variations of patterns (periodic, aperiodic and quasi periodic tiling are all possibile)
It takes advantages of React, SVG and Framer Motion to make the most simple cool and fluid animated patterns on the web. All scalable, interactable and fine-tunable.

## Installation
Open the folder with VisualStudio Code and type in the Terminal

```bash
npm install
```
or
```bash
yarn install
```

## Usage

```jsx
let patternSettings = {
horizontal: {
spacing: 0, //space between lines
atoms: 20, //number of logos per line
quasiPeriodicHorizontalFlip: true, //ordered chaos
evenOddVerticalFlip: true, //flip every other logo
phase: //can be 'periodic' or 'quasiperiodic'
},
vertical: {
spacing: 0, //space between columns
atoms: 20, //number of logos per column
quasiPeriodicHorizontalFlip: true, //ordered chaos
evenOddVerticalFlip: true, //flip every line
phase: false //can be 'periodic' or 'quasiperiodic'
}
}
return(<svg><PatternMaker set={patternSettings} /></svg>)


```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

## License
[MIT](https://choosealicense.com/licenses/mit/)

0 comments on commit 0105dea

Please sign in to comment.