Skip to content

Commit 2a4aba6

Browse files
JorchCortezJorchCortez
authored
Update README.md
1 parent 76fe2e0 commit 2a4aba6

1 file changed

Lines changed: 117 additions & 2 deletions

File tree

‎README.md‎

Lines changed: 117 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,117 @@
1-
# WebflowTrickery
2-
Webflow Trickery is an Open Source project focused on creating reusable functionalities for web platforms and developers out there
1+
<p align="center">
2+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/releases">
3+
<img alt="GitHub release (latest by semver)" src="https://img.shields.io/github/v/release/TheCodeRaccoons/WebflowTrickery?color=%2360be86&label=Latest%20release&style=for-the-badge&sort=semver">
4+
</a>
5+
<a href="/LICENSE">
6+
<img alt="GitHub" src="https://img.shields.io/github/license/TheCodeRaccoons/WebflowTrickery?color=%2360be86&style=for-the-badge">
7+
</a>
8+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/graphs/contributors">
9+
<img alt="GitHub contributors" src="https://img.shields.io/github/contributors-anon/TheCodeRaccoons/WebflowTrickery?color=%2360be86&style=for-the-badge">
10+
</a>
11+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/issues?q=is%3Aopen+is%3Aissue+label%3Arequest%3Aicon">
12+
<img alt="GitHub issues by-label" src="https://img.shields.io/github/issues/TheCodeRaccoons/WebflowTrickery/request:icon?color=%2360be86&label=icon%20requests&style=for-the-badge">
13+
</a>
14+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery/stargazers">
15+
<img alt="GitHub repository stars" src="https://img.shields.io/github/stars/TheCodeRaccoons/WebflowTrickery?color=%2360be86&label=github%20stars&style=for-the-badge">
16+
</a>
17+
</p>
18+
<br />
19+
<div align="center">
20+
<a href="https://github.com/TheCodeRaccoons/WebflowTrickery">
21+
<img src="https://raw.githubusercontent.com/TheCodeRaccoons/Imagery/16a395115ab598a94a7d1ab93f182218d8bbb751/wt-logo.svg" alt="Webflow Trickery Logo" height="140" />
22+
</a>
23+
<h5 align="center">
24+
Webflow Trickery aims to create easy to implement, reusable functionalities for the web. As it's name implies, the main platform this project targets is <a href="https://webflow.com/">Webflow</a>, but the majority of the scripts are made with general web development in mind. Meaning that most of this scripts should work without an issue on any website unless it is a CMS functionality or a Webflow specific script.
25+
</h5>
26+
<p align="center">
27+
<a target="_blank" href="https://github.com/TheCodeRaccoons/WebflowTrickery/issues/new/choose">Request a functionality</a>
28+
&middot;
29+
<a href="#contribute">Contribute</a>
30+
</p>
31+
</div>
32+
33+
<h2>TL;DR</h2>
34+
All of the documentation is explained by functionality in <a href="https://coderacoons.webflow.io/tools/webflow-trickery">the website</a>. Feel free to browse there or request any aditional functionalities in the <a target="_blank" href="https://github.com/TheCodeRaccoons/WebflowTrickery/issues/new/choose">issues</a> section of this project.
35+
36+
<h2>Table of Contents</h2>
37+
<ol>
38+
<li><a href="#about">About the Project</a></li>
39+
<li><a href="#getting-started">Getting Started</a></li>
40+
<li><a href="#request-functionality">Requesting a Functionality</a></li>
41+
<li><a href="#contribute">Contributing</a></li>
42+
<li><a href="#discord-community">Discord Community</a></li>
43+
<li><a href="#develop-vs-master"><code>develop</code> vs <code>master</code></a></li>
44+
<li><a href="#stale-prs">Stale Pull Requests</a></li>
45+
<li><a href="#building-devicon">Building Devicon</a></li>
46+
</ol>
47+
48+
<h2 id="about">About the Project</h2>
49+
<p>
50+
As any other developer using no-code web design tools I've struggled with the ability to bring specific, more complex functionalities to platforms like Webflow.
51+
<br/><br/>
52+
Over the past couple of years I started noticing some of this functionalities are not only commonly used but also requested by many in the community. Webflow trickery aims to empower developers and designers alike, provinding both simple and complex functionalities that could, in other cases, take longer to develop from scratch.
53+
<br/><br/>
54+
This being said even though most of this functionalities are built for Webflow, there's many that can be used in any other web project and platform. Feel free to see the full <a href="https://coderacoons.webflow.io/tools/webflow-trickery">documentation</a> in our site for the complete list of functionalities and scripts available.
55+
</p>
56+
<sub>
57+
Webflow Trickery might have been started as a personal project, but I'm a believer that a project for the comunity by the comunity can offer way more value than any single dev could provide so feel free to contribute to this project and use any solution here.
58+
</sub>
59+
60+
<h2 id="getting-started">Getting Started</h2>
61+
62+
```html
63+
Include each script or pack scripts together.
64+
For a faster load, download the scripts and add to your project
65+
packages will be added in a future version
66+
```
67+
68+
<h2 id="request-functionality">Requesting a functionality</h2>
69+
<p>
70+
When you want to request an icon please feel free to create an issue. Check out our <a href="https://github.com/devicons/devicon/wiki/Requesting-an-Icon">Wiki</a> for more information.
71+
</p>
72+
73+
<h2 id="contribute">Contributing</h2>
74+
<p>
75+
We are happy with every contribution, whether it's new icons, features, or maintainers. Please have a look at our <a href="https://github.com/devicons/devicon/wiki">Wiki</a> to see how you can contribute to this project.
76+
</p>
77+
78+
<h2 id="discord-community">Discord community</h2>
79+
<p>
80+
We are building a community on discord. You can easily discuss, and have a good time talking with the community members! an official discord link will be released in a later date to allow the community to chat.
81+
</p>
82+
83+
<h2 id="develop-vs-master"><code>develop</code> vs <code>master</code></h2>
84+
<p>
85+
All official releases shall be in <code>master</code>. Any updates in between (updates, new functionalities, features, etc.) will be kept in <code>develop</code>.
86+
</p>
87+
<b><code>develop</code> contains:</b>
88+
<ul>
89+
<li>
90+
Latest functions, lightly optimized, throughly tested.
91+
</li>
92+
<li>
93+
No full docs in the website for this functions, they will be released with the latest release, though the dev branch will have it's own.<br>
94+
</li>
95+
<li>
96+
Experimental changes.
97+
</li>
98+
</ul>
99+
<b><code>master</code> contains:</b>
100+
<ul>
101+
<li>
102+
Latest official release, including all functionalities, well optimized and under support.
103+
</li>
104+
<li>
105+
Official, well tested changes.
106+
</li>
107+
</ul>
108+
109+
<h2 id="stale-prs">Stale Pull Requests</h2>
110+
<p>
111+
After a pull request has been open for over 30 days with no activity or response from the author, it'll be automatically marked as stale. We might fork your changes and merge the changes ourselves. Since GitHub tracks contributions by commits, you will be credited.
112+
</p>
113+
<br/>
114+
<div align="center">
115+
<img src="https://forthebadge.com/images/badges/built-with-love.svg" />
116+
<img src="https://forthebadge.com/images/badges/built-by-developers.svg" />
117+
</div>

0 commit comments

Comments
 (0)