Skip to content

Commit 85c1019

Browse files
tooommZeldaZach
authored andcommitted
README tweaks (#161)
1 parent 41b0c04 commit 85c1019

File tree

2 files changed

+51
-18
lines changed

2 files changed

+51
-18
lines changed

LICENSE-MIT LICENSE

File renamed without changes.

README.md

+51-18
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,77 @@
11
<p align="center">
2-
dr<img src="https://raw.githubusercontent.com/dr4fters/dr4ft/master/public/4.png" height="14">ft
2+
dr<img src="https://raw.githubusercontent.com/dr4fters/dr4ft/master/public/4.png" alt="4" height="14">ft
33
</p>
44

55
<p align='center'>
66
<a href="https://travis-ci.com/dr4fters/dr4ft"><img src=https://travis-ci.com/dr4fters/dr4ft.svg?branch=master></a>
77
<a href="https://david-dm.org/dr4fters/dr4ft"><img src=https://david-dm.org/dr4fters/dr4ft.svg></a>
88
<a href="https://david-dm.org/dr4fters/dr4ft?type=dev"><img src=https://david-dm.org/dr4fters/dr4ft/dev-status.svg></a>
9-
</p> <br>
9+
</p>
10+
11+
12+
13+
<br>
14+
15+
# dr4ft [![Chat](https://badges.gitter.im/dr4fters/dr4ft.svg)](https://gitter.im/dr4fters/dr4ft)
16+
17+
*dr4ft* is a <kbd>Node</kbd> application.<br>
18+
*dr4ft* is written in [ES6] and transpiled with [Babel], and uses [React] on the client-side.
19+
20+
Found **bugs** or have **feature requests**? Feel free to [open an issue](https://github.com/dr4fters/dr4ft/issues/new)!
21+
22+
1023

24+
<br>
1125

12-
# dr4ft [![Join the chat at https://gitter.im/dr4fters/dr4ft](https://badges.gitter.im/dr4fters/dr4ft.svg)](https://gitter.im/dr4fters/dr4ft?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
26+
# Project History
1327

28+
*dr4ft* is a fork of *arxanas*' `drafts.ninja` fork of *aeosynth*'s `draft` project:
1429

30+
`draft` (initial project, discontinued)<br>
31+
&nbsp;&nbsp;&nbsp;`drafts.ninja` (fork, discontinued)<br>
32+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;**`dr4ft`** (fork, **current main project**)
1533

16-
[dr4ft](http://dr4ft.info) is a fork of arxanas' `drafts.ninja` fork of aeosynth's `draft` project.<br>
17-
It supports all of the features of `drafts.ninja`, and more.
34+
It supports all their features, and many more.
1835

19-
dr4ft is a NodeJS application.<br>
20-
dr4ft is written in [ES6] and transpiled with [BabelJS], and uses [React] on the client-side.
36+
#### Known pages running this code:
37+
- [dr4ft.com](http://dr4ft.com)
38+
- [dr4ft.info](https://www.dr4ft.info/)
2139

22-
Bugs or feature requests? Feel free to [open an issue](https://github.com/dr4fters/dr4ft/issues/new).
40+
41+
42+
<br>
2343

2444
# Installation
2545

26-
Install NodeJS, then just run `npm install && npm start`
27-
in your terminal and visit [http://localhost:1337](http://localhost:1337).
46+
### Native
47+
48+
1) Install [Node.js](https://nodejs.org/en/download/)
49+
2) Run `npm install && npm start`
50+
3) Visit [http://localhost:1337](http://localhost:1337)
51+
2852

29-
# Docker
53+
### Docker
3054

31-
If you want, instead of hosting the server on your system, you can create a dr4ft container.
55+
You can also create a Docker image and run the app in a container:
56+
1) Install [Docker](https://www.docker.com/)
57+
2) Build the image:<br>
58+
`docker build -t dr4ft-app .`
59+
3) Run it in a container:<br>
60+
`docker run -dp 1337:1337 dr4ft-app`<br>
61+
4) Visit [http://localhost:1337](http://localhost:1337)
3262

33-
Just download docker and build the container:<br>`docker build -t dr4ft-app .`
3463

35-
Then run it:<br>`docker run -dp 1337:1337 dr4ft-app`<br> and visit [http://localhost:1337](http://localhost:1337).
3664

37-
<br><br>
38-
The project is unaffiliated with Wizards of the Coast,
39-
and is licensed under the MIT license.
65+
<br>
66+
67+
<p align='center'>
68+
<sub><i>The project is unaffiliated with Wizards of the Coast, and is licensed under the MIT license.</i></sub>
69+
</p>
70+
4071

4172

73+
<!-- this are reference links -->
4274
[ES6]: https://github.com/lukehoban/es6features
43-
[BabelJS]: https://github.com/babel/babel
75+
[Babel]: https://github.com/babel/babel
4476
[React]: https://github.com/facebook/react
77+

0 commit comments

Comments
 (0)