Skip to content

Commit

Permalink
Feature/0.2.0 (#7)
Browse files Browse the repository at this point in the history
* WIP bumped dev deps, example failing

* Ignoring cache

* Updates for v0.2.0
  • Loading branch information
desholmes authored Oct 6, 2021
1 parent 4d8618c commit ff9ea36
Show file tree
Hide file tree
Showing 18 changed files with 7,986 additions and 3,095 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
.cache
.parcel-cache/
node_modules

/dist/example*
Expand Down
21 changes: 18 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ A simple, extendable terminal interface for the web, used by [text-quest](https:

### Option 1 Use the CSS and JavaScript in your HTML

Follow the example below to include the CSS and JavaScript directly into your HTML page:
Follow the example below to include the CSS and JavaScript directly into your HTML page (download the files from [GitHub](https://github.com/desholmes/text-terminal/tree/main/dist)):

```html
<html>
Expand Down Expand Up @@ -122,6 +122,16 @@ const config = {

![sunset](https://user-images.githubusercontent.com/1830123/98744070-ff526580-23a8-11eb-8140-04727285d6f6.png)

### Jinx

```javascript
const config = {
theme: "jinx",
};
```

![jinx](https://user-images.githubusercontent.com/1830123/136161299-287f4ffe-cc87-4193-8894-c4109c805022.png)

---

## Default Commands
Expand All @@ -143,7 +153,8 @@ Outputs the version of Text Terminal.
```js
terminal.version();

Text Terminal v0.1.0
Text Terminal v0.2.0

```

## Methods
Expand All @@ -152,12 +163,16 @@ These methods are exposed by Text Terminal for you to use:

### clear()

Clears the contents of the terminal output.

```js
terminal.clear();
```

### output()

Add a string to the terminal output.

```js
terminal.output("Hey Text Terminal!");

Expand All @@ -170,7 +185,7 @@ Hey Text Terminal!

If you're interested in contributing use the commands below:

1. `npm`: Install deps
1. `npm i`: Install deps
1. `npm start`: Start local dev server
1. `npm run build`: Builds the js and css files to [./dist](./dist)

Expand Down
17 changes: 17 additions & 0 deletions dist/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
<html>
<head><link rel="stylesheet" href="/index.b0075736.css">
<meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no">
</head>
<style>
body {
margin: 0;
padding: 0;
overscroll-behavior-y: none;
}

</style>
<body>
<div id="text-terminal"></div>
<script src="/index.855f7fd1.js" defer=""></script>
</body>
</html>
4 changes: 2 additions & 2 deletions dist/text-terminal.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion dist/text-terminal.css.map

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 0 additions & 12 deletions dist/text-terminal.js

This file was deleted.

Loading

0 comments on commit ff9ea36

Please sign in to comment.