Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
aheze authored Sep 9, 2021
1 parent 47aaa29 commit 938e9bf
Showing 1 changed file with 72 additions and 4 deletions.
76 changes: 72 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,76 @@

[![StitchCounter](Assets/head.png)](https://github.com/aheze/StitchCounter/raw/main/Assets/StitchCounter.zip)

**An app to count your crochet pattern's stitches!** Made with SwiftUI. [Download zip](https://github.com/aheze/StitchCounter/raw/main/Assets/StitchCounter.zip).
**An app to count your crochet pattern's stitches!** Made with SwiftUI with no 3rd party dependencies. [Mac app](https://github.com/aheze/StitchCounter/raw/main/Assets/StitchCounter.zip)[iOS app](https://github.com/aheze/StitchCounter/raw/main/Assets/StitchCounter.ipa)


### Purpose
To count the number of stitches in a crochet pattern. My sister runs an Etsy shop, [StuffingStuff](https://www.etsy.com/shop/StuffingStuff), which sells crochet stuff and patterns. Supposedly, manually counting stitches to make a pattern is very tedious and error-prone. This app makes it easy.

### Features

<table>
<tr>
<td>
Counter
</td>
<td>
Settings
</td>
</tr>



<tr>
<td>
<img src="Assets/main.png">
</td>
<td>
<img src="Assets/settings.png">
</td>
</tr>

<tr>
<td colspan="2"><br>

- Write any pattern, then press <strong>Count</strong>. That's it!
- It's powered by regex, so your pattern doesn't need to be perfect.
- Press the number to copy it to your clipboard.
- The breakdown lets you double-check to make sure everything is right.
- Have your own stitch abbreviations? No problem, just go to **Settings**, then press <strong>Save</strong>.
- Stitch abbreviations support regex too.
- You can even set the number of stitches for each abbreviation.
</td>
</tr>
</table>


### Crochet abbreviation reference

<details>
<summary><strong>What's crochet?</strong></summary>

<br>

> Crochet is a process of creating textiles by using a crochet hook to interlock loops of yarn, thread, or strands of other materials. The name is derived from the French term crochet, meaning 'small hook'. Hooks can be made from a variety of materials, such as metal, wood, bamboo, or plastic. — [Wikipedia](https://en.wikipedia.org/wiki/Crochet)
![](Assets/crochet.png)

---
</details>


<details>
<summary><strong>What are patterns?</strong></summary>

<br>

It's like an instruction manual, but for crocheting.

---
</details>





Counter | Settings
--- | ---
![Counter screen](Assets/main.png) | ![Settings screen](Assets/settings.png)

0 comments on commit 938e9bf

Please sign in to comment.