Skip to content

Commit 6532797

Browse files
committed
README + assets
1 parent d9c1076 commit 6532797

File tree

2 files changed

+138
-2
lines changed

2 files changed

+138
-2
lines changed

README.md

Lines changed: 138 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,138 @@
1-
# moonscript
2-
Full-Stack Programming Language
1+
<p align="center">
2+
<a href="https://github.com/moonscriptofficial/moonscript">
3+
<img height="128" src="https://github.com/moonscriptofficial/moonscript/blob/main/assets/moon.png">
4+
</a>
5+
<h1 align="center">MoonScript</h1>
6+
</p>
7+
8+
<p align="center">
9+
<a href="https://www.npmjs.com/package/your-language">
10+
<img src="https://img.shields.io/npm/dm/your-language.svg" alt="NPM downloads"/>
11+
</a>
12+
<a href="https://github.com/your-repository/issues">
13+
<img src="https://img.shields.io/github/issues/your-repository" alt="Open Issues"/>
14+
</a>
15+
<a href="https://github.com/your-repository/pulls">
16+
<img src="https://img.shields.io/github/prs/your-repository" alt="Pull Requests"/>
17+
</a>
18+
</p>
19+
20+
21+
## Overview
22+
23+
Welcome to **MoonScript**, the next-generation, full-stack web programming language designed for **simplicity**, **speed**, and **efficiency**! 🚀
24+
25+
With **MoonScript**, you can develop dynamic and scalable web applications with **ease** and **speed**. The syntax is intuitive, and compilation times are drastically reduced, making development faster than ever before. It is tailored to help developers build modern, interactive web apps, and is packed with powerful features that ensure your projects stay lightweight and performant.
26+
27+
---
28+
29+
## Features
30+
31+
- 🔥 **Low Compilation Time**: MoonScript compiles faster than traditional frameworks, thanks to its lightweight and optimized architecture.
32+
- 🚀 **Faster Execution**: Code written in **MoonScript** runs **faster** compared to others, thanks to its low-level optimizations.
33+
- 🌍 **Cross-Platform Support**: Seamlessly write applications that can run on all platforms with minimal code changes.
34+
- 🧩 **Component-Based Design**: Write reusable, self-contained components with the same structure you use for HTML and CSS.
35+
- 💻 **Web Focused**: Perfect for building both the **frontend** and **backend** of modern web applications.
36+
- 🎨 **CSS-Inspired Styling**: Writing styles has never been easier, as our syntax for styles is directly influenced by CSS. You’ll feel right at home if you’re familiar with web design.
37+
38+
---
39+
40+
## Example Syntax
41+
42+
Here's a simple component written in **MoonScript** that demonstrates how easy it is to define components, properties, and styles:
43+
44+
```ruby
45+
component HelloWorld {
46+
property color = "#333"
47+
property done = false
48+
property label = ""
49+
50+
style label {
51+
font-weight: bold;
52+
color: #{color};
53+
flex: 1;
54+
55+
if (done) {
56+
text-decoration: line-through;
57+
}
58+
}
59+
60+
fun render {
61+
<div>
62+
<span::label>
63+
label
64+
</span>
65+
</div>
66+
}
67+
}
68+
```
69+
70+
### Explanation:
71+
- **Component Definition**: The `component TodoItem` block defines a reusable component that encapsulates all its properties, styling, and behavior.
72+
- **Properties**: Properties like `color`, `done`, and `label` are defined within the component and can be accessed throughout the component's lifecycle.
73+
- **Styling**: The `style` block defines how elements inside the component will look. It’s similar to CSS, but with more power and flexibility.
74+
- **Render Function**: The `fun render` function is where the UI elements are rendered using the component's properties and styling.
75+
76+
---
77+
78+
## Why Choose **MoonScript**?
79+
80+
### **Speed**
81+
When it comes to web development, speed is crucial. Unlike other frameworks, **MoonScript** is designed to minimize compilation times without sacrificing performance. The end result? **Lightning-fast compilation and execution**.
82+
83+
### 🌐 **Web-first Design**
84+
Built for the web, **MoonScript** makes it easy to create web applications that are scalable and maintainable. Whether you're working on small websites or large-scale applications, this language supports both.
85+
86+
### 🔧 **Minimal Boilerplate**
87+
We’ve made sure to keep things simple. With **MoonScript**, you don't have to write hundreds of lines of setup code. Focus more on building features and less on configuration.
88+
89+
### 🌟 **Ready for Production**
90+
With a lightweight, optimized architecture, **MoonScript** ensures your web apps run smoothly from day one, giving you **performance** you can rely on.
91+
92+
---
93+
94+
## Installation
95+
96+
To get started with **MoonScript**, simply follow the installation steps below.
97+
98+
### 1. Create Your First Project
99+
100+
```bash
101+
moon init AwesomeProject
102+
cd AwesomeProject
103+
moon start
104+
```
105+
106+
### 2. Start Coding!
107+
108+
Your development server should now be running! Open your browser to `http://localhost:3000`, and you’re ready to start building!
109+
110+
---
111+
112+
## Contributing
113+
114+
We’re always looking for contributors to help us improve **MoonScript**. If you have ideas, fixes, or features you’d like to contribute, feel free to open an issue or submit a pull request!
115+
116+
### How to Contribute:
117+
1. Fork the repository.
118+
2. Create a new branch (`git checkout -b feature-name`).
119+
3. Make your changes.
120+
4. Commit your changes (`git commit -am 'Add new feature'`).
121+
5. Push to the branch (`git push origin feature-name`).
122+
6. Open a pull request.
123+
124+
---
125+
126+
## License
127+
128+
Distributed under the **MIT License**. See the [LICENSE](LICENSE) file for more information.
129+
130+
---
131+
132+
## Let's Build Together!
133+
134+
With **MoonScript**, building web applications is a breeze! Whether you're a beginner or an experienced developer, our toolset will help you ship products faster than ever before.
135+
136+
Feel free to check out the source code, contribute, or just get started on your next project!
137+
138+
Happy coding! 🌟

assets/moon.png

68.8 KB
Loading

0 commit comments

Comments
 (0)