Align Text Line
Technologies | Prerequisites | How To Use | How To Contribute | License
## :information_source: How To Use
```bash
# Start the app
$ yarn add align-text-line
# or
$ npm install align-text-line
```
### Sample
```typescriptlang
import align from 'align-text-line'
const textAlignedLeft = align.leftAligned('text', '-', 30)
const textAlignedRight = align.rightAligned('text', '-', 30)
const textAlignedCentralized = align.centralized('text', '-', 30)
const textAlignedWithSpaceCentralized = align.leftRightAligned(
'bola',
'carro',
'-',
30
)
console.log(textAlignedLeft)
console.log(textAlignedRight)
console.log(textAlignedCentralized)
console.log(textAlignedWithSpaceCentralized)
```
## :information_source: How To Contribute
To clone and run this application, you'll need [Git](https://git-scm.com), [Node.js v12.18][nodejs] or higher + [Yarn v1.22][yarn] or higher installed on your computer. From your command line:
### Fork the repository
```bash
# Clone this forked repository
$ git clone https://github.com/your_repository/align-text-line.git
# Go into the repository
$ cd align-text-line
# Add this remote repository
$ git remote add mckatoo https://github.com/mckatoo/align-text-line.git
# Update your local repository if necessary
$ git fetch mckatoo
# Merge your local repository with recentily pushed
$ git merge mckatoo/master
# Push local repository updated for your remote repository
$ git push
# Never work on the main branch
$ git checkout -b your-branch
# There, you can start the job.
# Install dependencies
$ yarn
# or
$ npm install
# Run the app
$ yarn develop
# or
$ npm run develop
# After the modifications are finished, do it.
$ git add .
$ git commit
# This project uses commitizen and commitlint to standardize and organize commits.
# Follow the steps indicated by commitizen.
# After committing, it's time to send your branch
$ git push origin your-branch
# To open a pull request go to your github repository and click on the green button labeled 'Compare & pull request'
# Check all the data and describe the pull request with clear and direct information.
# Click on the green button labeled 'Create pull request'.
# Okay, now just wait for approval or not.
```
For a better illustration of the process, follow a video by [Diego Fernandes of RocketSeat](https://youtu.be/mcd7lqpUzIA)
## :memo: License
This project is under the MIT license. See the [LICENSE](https://github.com/mckatoo/align-text-line/blob/master/LICENSE) for more information.
---
Made with ♥ by Milton Carlos Katoo :wave: Get in touch!
[nodejs]: https://nodejs.org/
[yarn]: https://yarnpkg.com/
---
_Source: https://npm.io/package/align-text-line · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._