Skip to content

Commit 463d802

Browse files
authored
Merge pull request #52 from TryShape/issue-51-update-readme
Issue 51 update readme
2 parents 5f7c98a + 737f5a1 commit 463d802

1 file changed

Lines changed: 94 additions & 1 deletion

File tree

README.md

Lines changed: 94 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,94 @@
1-
This is a starter template for [Learn Next.js](https://nextjs.org/learn).
1+
<p align="center">
2+
<a href="https://tryshape.vercel.app/">
3+
<img src="https://res.cloudinary.com/atapas/image/upload/v1624866501/demos/tryshape_xpzie7.png" alt="logo" width="125"/>
4+
</a>
5+
<p/>
6+
7+
<h4 align="center">Create, Export, Share, and Use any Shapes of your choice.</h4>
8+
9+
<p align="center">
10+
<a href="https://github.com/TryShape/tryshape/blob/master/LICENSE" target="blank">
11+
<img src="https://img.shields.io/github/license/TryShape/tryshape?style=flat-square" alt="tryshape licence" />
12+
</a>
13+
<a href="https://github.com/TryShape/tryshape/fork" target="blank">
14+
<img src="https://img.shields.io/github/forks/TryShape/tryshape?style=flat-square" alt="tryshape forks"/>
15+
</a>
16+
<a href="https://github.com/TryShape/tryshape/stargazers" target="blank">
17+
<img src="https://img.shields.io/github/stars/TryShape/tryshape?style=flat-square" alt="tryshape stars"/>
18+
</a>
19+
<a href="https://github.com/TryShape/tryshape/issues" target="blank">
20+
<img src="https://img.shields.io/github/issues/TryShape/tryshape?style=flat-square" alt="tryshape issues"/>
21+
</a>
22+
<a href="https://github.com/TryShape/tryshape/pulls" target="blank">
23+
<img src="https://img.shields.io/github/issues-pr/TryShape/tryshape?style=flat-square" alt="tryshape pull-requests"/>
24+
</a>
25+
<a href="https://twitter.com/intent/tweet?text=Check%20this%20amazing%20app%20https://tryshape.vercel.app/,%20created%20by%20@tapasadhikary%20and%20friends%0A%0A%23DEVCommunity%20%23100DaysOfCode%20%23tryshape"><img src="https://img.shields.io/twitter/url?label=Share%20on%20Twitter&style=social&url=https%3A%2F%2Fgithub.com%2FTryShape%2Ftryshape"></a>
26+
27+
</p>
28+
29+
<p align="center">
30+
<a href="https://tryshape.vercel.app/" target="blank">View Demo</a>
31+
·
32+
<a href="https://github.com/TryShape/tryshape/issues/new/choose">Report Bug</a>
33+
·
34+
<a href="https://github.com/TryShape/tryshape/issues/new/choose">Request Feature</a>
35+
</p>
36+
37+
## Introducing TryShape
38+
`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.
39+
40+
## Demo
41+
TBA
42+
43+
## What's In TryShape
44+
`TryShape` comes with a bundle of features to give your creativity a shape. You can do the followings with TryShape,
45+
### Create Shapes
46+
- Create any shapes using an intuitive editor.
47+
- Create Polygonal, Circular, Elliptical shapes without knowing the underlying complexities like CSS clip-path.
48+
- Add/Remove vertices, join them, drag-drop to position them to create a shape.
49+
- Provide your choice of colors, add the contextual information as notes while creating the shapes.
50+
- Are you an expert in CSS clip-path? Great, you can add a clip-path value directly and start from there.
51+
52+
### Controlling the Visibility of Shapes
53+
- You can create a shape and share with the TryShape community by making it public.
54+
- Do you want to keep your creativity private? No worries, that's possible too.
55+
56+
### Like Shapes
57+
- 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.
58+
59+
### Export Shapes
60+
- Export the shapes to use in your application.
61+
- Export the shapes as PNG, JPEG, and SVG files.
62+
- Single-Click Copy of the undering CSS and clip-path proprty to use directly into your webapp.
63+
64+
### Search Shapes
65+
- Search a shape with key-in search.
66+
67+
### Sort Shapes
68+
- Sort shapes by, most liked, recent, and oldest.
69+
### Authentication & Authorization
70+
- 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`.
71+
72+
## How to Set up TryShape for Development?
73+
TBA
74+
75+
## Upcoming Features
76+
`TryShape` has all the potentials to grow further. Here are some of the upcoming features planned(not in any order),
77+
78+
- Add the ability to create shape using SVG elements to support Curvy Node adjustments.
79+
- Manage your shape collection
80+
- Show Trending shapes
81+
- Import shapes
82+
- Following a contributor.
83+
- PWA(Progressive Web App)
84+
- Accessibility improvements
85+
- Flexible Datastore
86+
- Better Performance
87+
- Tagging a shape
88+
- Provide comment on a shape.
89+
- More authetication mechanisms like twitter, facebook, etc.
90+
91+
If you find something is missing, `TryShape` is listening. Please create a feature request [from here](https://github.com/TryShape/tryshape/issues/new/choose).
92+
93+
## Contributions
94+
TBA

0 commit comments

Comments
 (0)