Skip to content

Commit 253eddd

Browse files
committed
Improve readme
1 parent 528c146 commit 253eddd

File tree

1 file changed

+10
-27
lines changed

1 file changed

+10
-27
lines changed

README.md

Lines changed: 10 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,18 @@
1-
![Image](../master/docs/assets/logo.png?raw=true)
1+
# Codebox
2+
> "Open source cloud-based web IDE."
23
3-
Codebox is a complete and extensible Cloud IDE. It cans runs on any unix machines (Linux, Mac OS X). It is an open source component of [Codebox.io](https://www.codebox.io) (Cloud IDE as a Service).
4+
Codebox is a complete and extensible Cloud IDE. It cans runs on any unix machines (Linux, Mac OS X). It is an open source component of [codebox.io](https://www.codebox.io) (Cloud IDE as a Service).
45

5-
![Image](../master/docs/assets/base.png?raw=true)
6-
7-
## Why is Codebox great?
8-
9-
* Easy to run on your desktop, server or cloud
10-
* Build with web technologies: javascript, less, node.js
11-
* Natively collaborative
12-
* Extensible Architecture
13-
* Offline mode
14-
15-
## How to use it?
6+
It's easy to run the IDE on your desktop (Linux and Mac), your server or the cloud. You can use [codebox.io](https://www.codebox.io) to host and manage the IDE for you and let you focus on
167

17-
#### Mac Application
8+
Codebox is build only with web technologies: node.js, javasctipt, html and less. The IDE is also build with a very extensible architecture, it lets you build your own features and functionnalities with an add-on system.
189

19-
Coming soon
10+
**Questions:** Feel free to ask any questions or signal problems by adding issues.
2011

21-
#### Command Line
12+
**News:** You can get update about Codebox on [Twitter](https://twitter.com/CodeboxIO).
2213

23-
First of all install codebox on your machine using npm:
14+
**Usage:** Install Codebox using NPM: ```npm install -g codebox```, and use it with: ```codebox run ./myworkspace```
2415

25-
```
26-
$ npm install -g codebox
27-
```
16+
**Documentation:** Complete documentation can be found in [docs](https://github.com/FriendCode/codebox/blob/master/docs).
2817

29-
You can now run Codebox into a directory (Codebox can only be run on GIT repository):
30-
31-
```
32-
$ codebox run ./myworkspace
33-
```
34-
35-
Complete documentation can be found in [docs](https://github.com/FriendCode/codebox/blob/master/docs).
18+
![Image](../master/docs/assets/base.png?raw=true)

0 commit comments

Comments
 (0)