Skip to content

Commit 6cfd1c8

Browse files
authored
Update README.md
1 parent 8b8a99e commit 6cfd1c8

1 file changed

Lines changed: 31 additions & 28 deletions

File tree

README.md

Lines changed: 31 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@
3737
<a href="https://github.com/TryShape/tryshape/issues/new/choose">Request Feature</a>
3838
</p>
3939

40-
## 👋 Introducing `TryShape`
40+
# 👋 Introducing `TryShape`
4141
<p align="center">
4242
<a href="https://tryshape.vercel.app" target="blank"/>
4343
<img src="./public/readme/landing.png" alt="landing" />
@@ -46,53 +46,56 @@
4646

4747
`TryShape` is an opensource platform to create shapes of your choice using a simple, easy-to-use interface. You can create banners, circles, polygonal shapes, export them as SVG, PNG, and even as CSS.
4848

49-
## 🚀 Demo
49+
# 🚀 Demo
5050
Here is a quick demo of the app. We hope you enjoy it.
5151

5252
> [The Demo Link](https://www.youtube.com/watch?v=CB9xkhzkrYE)
5353
5454
Liked it? Please give a ⭐️ to <b>TryShape</b> to build its triceps 💪 stronger.
5555

56-
## 💻 Use TryShape
56+
# 💻 Use TryShape
5757
Please access TryShape using the URL:
5858

5959
> https://tryshape.vercel.app/
6060
61-
## 🔥 Features
62-
`TryShape` comes with a bundle of features to give your creativity a shape. You can do the followings with TryShape,
61+
# 🔥 Features
62+
`TryShape` comes with a bundle of features already. You can do the followings with it,
6363

64-
### ✅ Listing Shapes
65-
- List out shapes for you to pick and use.
66-
### ✅ Create Shapes
64+
## 🔢 Listing Shapes
65+
- List out shapes for you to pick and use.
66+
67+
## 🏗️ Create Shapes
6768
- Create any shapes using an intuitive editor.
6869
- Create Polygonal, Circular, Elliptical shapes without knowing the underlying complexities like CSS clip-path.
6970
- Add/Remove vertices, join them, drag-drop to position them to create a shape.
7071
- Provide your choice of colors, add the contextual information as notes while creating the shapes.
7172
- Are you an expert in CSS clip-path? Great, you can add a clip-path value directly and start from there.
7273

73-
### Controlling the Visibility of Shapes
74-
- You can create a shape and share with the TryShape community by making it public.
74+
## 📢 Controlling the Visibility of Shapes
75+
- You can create a shape and share it with the TryShape community by making it public.
7576
- Do you want to keep your creativity private? No worries, that's possible too.
7677

77-
### Like Shapes
78-
- Liked a shape and want to to add it to your shape collection? You can do that just with a click. Want to undo? That's supported as well.
78+
## 💘 Like Shapes
79+
- Liked a shape and want to add it to your shape collection? You can do that just with a click. Want to undo? That's supported as well.
7980

80-
### Export Shapes
81+
## Export Shapes
8182
- Export the shapes to use in your application.
8283
- Export the shapes as PNG, JPEG, and SVG files.
83-
- Single-Click Copy of the undering CSS and clip-path proprty to use directly into your webapp.
84+
- Single-Click Copy of the underlying CSS and clip-path property to use directly into your web app.
8485

85-
### Search Shapes
86+
## 🔍 Search Shapes
8687
- Search a shape with key-in search.
8788

88-
### Sort Shapes
89+
## 🎿 Sort Shapes
8990
- Sort shapes by, most liked, recent, and oldest.
90-
### ✅ Authentication & Authorization
91-
- Features like export, like, create, edit shapes need you to autheticate with the app. You can use your Gmail or GitHub credntials to authenticate to the app. It is secured and powered by `Google Firebase`.
92-
### ✅ Responsive and Mobile Friendly
93-
- Use `TryShape` seamlessly from any devices.
9491

95-
## 🏗️ How to Set up `TryShape` for Development?
92+
## 🔑 Authentication & Authorization
93+
- Features like export, like, create, edit shapes need you to authenticate with the app. You can use your Gmail or GitHub credentials to authenticate to the app. It is secured and powered by `Google Firebase`.
94+
95+
## 📱 Responsive and mobile-friendly
96+
- Use `TryShape` seamlessly from any device.
97+
98+
# 🏗️ How to Set up `TryShape` for Development?
9699
You can run TryShape locally with a few easy steps.
97100

98101
1. Clone the repository
@@ -136,7 +139,7 @@ npm run dev # or, yarn dev
136139

137140
That's All!!! Now open [localhost:3000](http://localhost:3000/) to see the app.
138141

139-
## 🍔 Built With
142+
# 🍔 Built With
140143
- [Next JS](https://nextjs.org/): The coolest React-based framework on the planet
141144
- [Harper DB](https://harperdb.io/): A flexible Data Store
142145
- [react-icons](https://react-icons.github.io/react-icons/): One shop for all the icons
@@ -154,10 +157,10 @@ That's All!!! Now open [localhost:3000](http://localhost:3000/) to see the app.
154157
- [html-to-image](https://github.com/bubkoo/html-to-image#readme): Converts an HTML element to image
155158
- [Vercel](http://vercel.com/): Best for Hosting a Next.js app
156159

157-
## 🛡️ License
160+
# 🛡️ License
158161
This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) file for details.
159162

160-
## 🦄 Upcoming Features
163+
# 🦄 Upcoming Features
161164
`TryShape` has all the potentials to grow further. Here are some of the upcoming features planned(not in any order),
162165

163166
- ✔️ Add the ability to create shape using SVG elements to support Curvy Node adjustments.
@@ -176,7 +179,7 @@ This project is licensed under the MIT License - see the [`LICENSE`](LICENSE) fi
176179

177180
If you find something is missing, `TryShape` is listening. Please create a feature request [from here](https://github.com/TryShape/tryshape/issues/new/choose).
178181

179-
## 🏃‍♀️ Deploy
182+
# 🏃‍♀️ Deploy
180183

181184
<a href="https://vercel.com/new/project?template=https://github.com/TryShape/tryshape">
182185
<img src="https://vercel.com/button" height="37.5px" />
@@ -186,14 +189,14 @@ If you find something is missing, `TryShape` is listening. Please create a featu
186189
</a>
187190

188191

189-
## 🤝 Contributing to `TryShape`
190-
Any kind of positive contributions are welcome! Please help us to grow by contributing to the project.
192+
# 🤝 Contributing to `TryShape`
193+
Any kind of positive contribution is welcome! Please help us to grow by contributing to the project.
191194

192195
If you wish to contribute, you can work on any features [listed here](https://github.com/TryShape/tryshape#-upcoming-features) or create one on your own. After adding your code, please send us a Pull Request.
193196

194197
> Please read [`CONTRIBUTING`](CONTRIBUTING.md) for details on our [`CODE OF CONDUCT`](CODE_OF_CONDUCT.md), and the process for submitting pull requests to us.
195198
196-
## 🙏 Support
199+
# 🙏 Support
197200

198201
We all need support and motivation. `TryShape` is not an exception. Please give this project a ⭐️ to encourage and show that you liked it. Don't forget to leave a star ⭐️ before you move away.
199202

0 commit comments

Comments
 (0)