https://github.com/travishorn/project-name

https://github.com/travishorn/project-name

Last synced: 28 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/travishorn/project-name
• Owner: travishorn
• License: mit
• Created: 2024-09-10T16:31:32.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-09-12T13:04:37.000Z (4 months ago)
• Last Synced: 2024-11-13T06:30:56.164Z (about 2 months ago)
• Language: JavaScript
• Size: 70.3 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Project Name

Tools for working with project names.

## Installation

```bash

npm install @travishorn/project-name

```

## Usage

### CLI

The only command available is `generate`, which will log a random project name to the console.

```sh

project-name generate

# A random, two-word project name will be logged to the console.

# Example: "Talented Support"

```

### API

The only function available is `generate`, which will return a random project name.

```javascript

import { generate } from "@travishorn/project-name";

console.log(await generate());

// A random, two-word project name will be logged to the console.

// Example: "Talented Support"

```

## Modifying the Word List

Words are stored in `src/adjectives.txt` and `src/nouns.txt`. You can modify the lists by editing these files.

## Contributing

Contributions are welcome! Please open an issue or submit a pull request.

If you modify the code, make sure to update the tests and documentation accordingly.

After modifying the code, make sure to run...

- `npm run format` to ensure consistency across the codebase.

- `npm run lint` to ensure there are no linting errors.

- `npm run test` to ensure all the tests pass.

## License

The MIT License (MIT)

Copyright 2024 Travis Horn

Permission is hereby granted, free of charge, to any person obtaining a copy of

this software and associated documentation files (the “Software”), to deal in

the Software without restriction, including without limitation the rights to

use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of

the Software, and to permit persons to whom the Software is furnished to do so,

subject to the following conditions:

The above copyright notice and this permission notice shall be included in all

copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS

FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR

COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.