Skip to content

Commit

Permalink
Add gitignore and update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
thedjpetersen committed Dec 7, 2023
1 parent f085d5b commit 7821d32
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 19 deletions.
3 changes: 2 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Basic modules which we expect to be ignored
coverage/
node_modules/
node_modules/
lib/
28 changes: 11 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,26 @@

<!-- PROJECT SHIELDS -->

[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/thedjpetersen/go-with-the-flow">
<a href="https://github.com/thedjpetersen/flow-like-water">
<img src="images/FlowControl.png" alt="Logo" width="250" height="250">
</a>

<h3 align="center">Go With the Flow 🤙</h3>
<h3 align="center">Flow like water 🤙</h3>

<p align="center">
Go with the flow and move easily through states.
Flow like water and move easily through states.
<br />
<a href="https://github.com/thedjpetersen/go-with-the-flow"><strong>Explore the docs »</strong></a>
<a href="https://github.com/thedjpetersen/flow-like-water"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/thedjpetersen/go-with-the-flow">View Demo</a>
<a href="https://github.com/thedjpetersen/flow-like-water">View Demo</a>
·
<a href="https://github.com/thedjpetersen/go-with-the-flow/issues">Report Bug</a>
<a href="https://github.com/thedjpetersen/flow-like-water/issues">Report Bug</a>
·
<a href="https://github.com/thedjpetersen/go-with-the-flow/issues">Request Feature</a>
<a href="https://github.com/thedjpetersen/flow-like-water/issues">Request Feature</a>
</p>
</div>

Expand Down Expand Up @@ -72,7 +66,7 @@ our states and transitions.
### Installation

```sh
npm install go-with-the-flow
npm install flow-like-water
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down Expand Up @@ -113,7 +107,7 @@ npm install go-with-the-flow

Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.

_For a full usage example please checkout the example listed in the [examples directory](https://github.com/thedjpetersen/go-with-the-flow/tree/main/examples)_
_For a full usage example please checkout the example listed in the [examples directory](https://github.com/thedjpetersen/flow-like-water/tree/main/examples)_

```typescript
// Import the necessary classes from the library
Expand Down Expand Up @@ -231,9 +225,9 @@ Distributed under the MIT License. See `LICENSE.txt` for more information.

## Contact

DJ Petersen - [@twitter_handle](https://twitter.com/thedjpetersen)
DJ Petersen - [@thedjpetersen](https://twitter.com/thedjpetersen)

Project Link: [https://github.com/thedjpetersen/go-with-the-flow](https://github.com/thedjpetersen/go-with-the-flow)
Project Link: [https://github.com/thedjpetersen/flow-like-water](https://github.com/thedjpetersen/flow-like-water)

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"name": "go-with-the-flow",
"name": "flow-like-water",
"version": "1.0.0",
"description": "A flow control library for handling series of asynchronous operations in JavaScript",
"main": "lib/index.js",
Expand Down

0 comments on commit 7821d32

Please sign in to comment.