Skip to content

Commit 793134f

Browse files
committed
Refine README.md for clarity and formatting consistency
1 parent c52eff9 commit 793134f

1 file changed

Lines changed: 21 additions & 14 deletions

File tree

README.md

Lines changed: 21 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Sliding TextBox Demo
1+
# Sliding TextBox Demo (React)
22

3-
A demonstration of smooth scrolling implementation to improve readability in translation subtitle systems.
3+
This is a React demo that showcases a smooth scrolling implementation to improve readability in translated subtitle systems. (You can see the Blazor version [here](https://github.com/sample-by-jsakamoto/Blazor-SlidingTextBox).)
44

55
When new text is added, typical implementations cause existing text to jump abruptly, making it difficult to read. The SlidingTextBox component solves this problem with smooth animation display.
66

@@ -21,23 +21,30 @@ When new text is added, typical implementations cause existing text to jump abru
2121

2222
### Installation
2323
1. Clone the repository:
24-
```bash
25-
git clone https://github.com/sample-by-jsakamoto/React-SlidingTextBox.git
26-
```
24+
25+
```bash
26+
git clone https://github.com/sample-by-jsakamoto/React-SlidingTextBox.git
27+
```
28+
2729
2. Navigate to the project directory:
28-
```bash
29-
cd React-SlidingTextBox
30-
```
30+
31+
```bash
32+
cd React-SlidingTextBox
33+
```
34+
3135
3. Install dependencies:
32-
```bash
33-
npm ci
34-
```
36+
37+
```bash
38+
npm ci
39+
```
40+
3541
### Running the Application
3642

3743
4. Start the development server:
38-
```bash
39-
npm run dev
40-
```
44+
45+
```bash
46+
npm run dev
47+
```
4148

4249
## License
4350

0 commit comments

Comments
 (0)