Skip to content

Commit 72df6ad

Browse files
committed
docs: add contributing message
1 parent ada54cd commit 72df6ad

File tree

1 file changed

+7
-25
lines changed

1 file changed

+7
-25
lines changed

README.md

Lines changed: 7 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -34,47 +34,29 @@ Check out https://abelljs.org for complete documentation.
3434

3535
## 🚀   Syntax Example
3636

37-
```jsx
37+
```vue
38+
<!-- index.abell -->
3839
<html>
3940
<body>
4041
I can render JavaScript! Look: {{ 10 + 10 }}
4142
</body>
4243
</html>
4344
```
4445

45-
This code outputs:
46-
46+
Output:
4747
```html
48+
<!-- index.html -->
4849
<html>
4950
<body>
5051
I can render JavaScript! Look: 20
5152
</body>
5253
</html>
5354
```
5455

55-
### 🤗 Local Installation & Contributing
56-
57-
Fork [abelljs/abell](https://github.com/abelljs/abell), Then follow these commands
58-
59-
```sh
60-
git clone https://github.com/:github-username/abell # Get a copy of the codebase in your codebase
61-
cd abell
62-
npm install # Installs all the dependencies
63-
npm link # This command will add the current directory to global packages.
64-
cd examples/main # Directory `examples` has sample abell projects.
65-
abell build # command to build project or
66-
abell serve # command to start dev server.
67-
```
68-
69-
We would love to have contributions! The contributing guidelines along with local setup guide is mentioned in [CONTRIBUTING.md](CONTRIBUTING.md)
56+
### 🤗 Contributing
7057

71-
### 💙 Related Repositories
72-
73-
- [abelljs/abell-website](https://github.com/abelljs/abell-website): Code of Documentation website of Abell (https://abelljs.org)
74-
- [abelljs/abell-renderer](https://github.com/abelljs/abell-renderer): Low-level API that deals with rendering of `.abell` files.
58+
The contributions might get a bit difficult to do right now since I am not quiet clear on which path the Abell is going to go. I will recommend contributing once Abell v1 gets a bit stable.
7559

7660
---
7761

78-
[<img alt="Buy me a Coffee Button" width=200 src="https://c5.patreon.com/external/logo/become_a_patron_button.png">](https://www.patreon.com/bePatron?u=31891872) &nbsp; [<img alt="Buy me a Coffee Button" width=200 src="https://cdn.buymeacoffee.com/buttons/default-yellow.png">](https://www.buymeacoffee.com/saurabhdaware)
79-
80-
If you want to know the status and get updates you can follow me on [Twitter @saurabhcodes](https://twitter.com/saurabhcodes)
62+
If you like my work, you can sponsor me on GitHub: https://github.com/sponsors/saurabhdaware 🌻

0 commit comments

Comments
 (0)