Skip to content
This repository was archived by the owner on Jul 6, 2025. It is now read-only.

Commit c5dce6b

Browse files
authored
Chore improve README.md file (#373)
* fix: Ignore `.idea` folder * feat(commands): Validate given project name * docs: Add README details * fix: update README.md
1 parent 43d246a commit c5dce6b

File tree

1 file changed

+40
-17
lines changed

1 file changed

+40
-17
lines changed

README.md

Lines changed: 40 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,49 @@
11
[![Aleph.js: The Full-stack Framework in Deno.](./design/poster.svg)](https://alephjs.org)
22

3-
<p>
4-
<a href="https://alephjs.org">Website</a> |
5-
<a href="https://alephjs.org/docs/get-started">Get Started</a> |
6-
<a href="https://alephjs.org/docs">Docs</a> |
7-
<a href="./CONTRIBUTING.md">Contributing</a>
8-
</p>
9-
103
<p>
114
<a href="https://discord.gg/pWGdS7sAqD"><img src="https://img.shields.io/discord/775256646821085215?color=%23008181&label=Chat&labelColor=%23111&logo=discord&logoColor=%23aaaaaa" alt="Chat"></a>
125
<a href="https://twitter.com/intent/follow?screen_name=alephjs"><img src="https://img.shields.io/twitter/follow/alephjs?style=social" alt="Twitter"></a>
136
</p>
147

15-
<details>
16-
<summary>Boom</summary>
17-
<p>
8+
## Getting Started
9+
10+
Visit [https://alephjs.org/docs/get-started](https://alephjs.org/docs/get-started) to get started with Aleph.js.
11+
12+
13+
## Description
14+
15+
Aleph.js (or **Aleph** or **א** or **阿莱夫**, **ˈɑːlɛf**) is a fullstack framework in [Deno](https://deno.land/), inspired by [Next.js](https://nextjs.org/). The name is taken from the book **The Aleph** by [Jorge Luis Borges](http://phinnweb.org/links/literature/borges/aleph.html).
16+
17+
Different with Next.js, Aleph.js doesn't need webpack or other bundler since it uses the [ES Moudule](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules) syntax during development. Every module only needs to be compiled once, and then cached on the disk. When a module changes, Aleph.js just needs to re-compile that single module. There is no time wasted re-bundling everytime a change is made. This, along with Hot Module Replacement (HMR) and Fast Refresh, leads to instant updates in the browser.
18+
19+
Aleph.js uses modern tools to build your app. It transpiles code using [swc](https://swc.rs/) in [WASM](https://webassembly.org/) with high performance, and bundles modules with [esbuild](https://github.com/evanw/esbuild) at build time extremely fast.
20+
21+
Aleph.js works in Deno, a simple, modern and secure runtime for JavaScript and TypeScript. All dependencies are imported using URLs, and managed by Deno cache system. No package.json and node_modules directory needed.
22+
23+
```ts
24+
import React from 'https://esm.sh/react'
25+
import Logo from '../components/logo.tsx'
26+
27+
export default function Home() {
28+
return (
29+
<div>
30+
<Logo />
31+
<h1>Hello World!</h1>
32+
</div>
33+
)
34+
}
35+
```
36+
37+
## Community
38+
39+
The Aleph.js community can be found on [GitHub Discussions](https://github.com/alephjs/aleph.js/discussions), where you can ask questions, voice ideas, and share your projects.
40+
41+
To chat with other community members you can join the Aleph.js [Discord](https://discord.com/invite/pWGdS7sAqD).
42+
43+
## Contributing
44+
45+
Please see our [contributing.md](https://github.com/alephjs/aleph.js/blob/master/CONTRIBUTING.md).
1846

19-
```bash
20-
# get started
21-
$ deno run -A https://deno.land/x/aleph/install.ts
22-
$ aleph -h
23-
```
47+
## License
2448

25-
</p>
26-
</details>
49+
Aleph.js [MIT licensed.](https://github.com/alephjs/aleph.js/blob/master/LICENSE)

0 commit comments

Comments
 (0)