Skip to content

Commit f1aa1f0

Browse files
navchandarnavchandar
authored
Updated usage
1 parent 219184c commit f1aa1f0

File tree

1 file changed

+86
-34
lines changed

1 file changed

+86
-34
lines changed

‎index.html‎

Lines changed: 86 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -45,68 +45,120 @@ <h2>Overview</h2>
4545
<section>
4646
<h2>Download</h2>
4747
<ul>
48-
<li>
49-
Simply https://github.com/navchandar/Python-Random-Name-Generator/releases/latest
50-
the repo to your project or clone it:
51-
</li>
48+
<li>Simply <a
49+
href="https://github.com/navchandar/Python-Random-Name-Generator/releases/latest">download</a>
50+
the release to your project or run the command</li>
5251
</ul>
5352
<div class="code-container">
5453
<pre><code id="git_clone">git clone https://github.com/navchandar/Python-Random-Name-Generator.git</code></pre>
5554
<span class="copy-icon" onclick="copyToClipboard('git_clone')" title="Copy Command">📋</span>
5655
</div>
5756

5857
<h2>Installation</h2>
59-
<h3>Using <code>requirements.txt</code></h3>
60-
<p>Add one of the following lines to your <code>requirements.txt</code> file:</p>
58+
<h3>Using <i>requirements.txt</i></h3>
59+
<p>Add one of the following lines to your <i>requirements.txt</i> file:</p>
6160

6261
<ul>
63-
<li><strong>Latest on <code>main</code> branch:</strong><br>
62+
<li><strong>Latest on <i>main</i> branch:</strong><br>
6463
<code>random-names @ git+https://github.com/navchandar/Python-Random-Name-Generator@main</code>
6564
</li>
66-
<li><strong>Specific tag (e.g., <code>V4.0</code>):</strong><br>
65+
<li><strong>Specific tag (e.g., <i>V4.0</i>):</strong><br>
6766
<code>random-names @ git+https://github.com/navchandar/Python-Random-Name-Generator@V4.0</code>
6867
</li>
68+
<li>
69+
<p>Then run:</p>
70+
<div class="code-container">
71+
<pre><code id="pip_install">pip install -r requirements.txt</code></pre>
72+
<span class="copy-icon" onclick="copyToClipboard('pip_install')" title="Copy Command">📋</span>
73+
</div>
74+
</li>
6975
</ul>
7076

71-
<p>Then run:</p>
72-
<div class="code-container">
73-
<pre><code id="pip_install">pip install -r requirements.txt</code></pre>
74-
<span class="copy-icon" onclick="copyToClipboard('pip_install')" title="Copy Command">📋</span>
75-
</div>
76-
77-
<h3>Using Poetry (<code>pyproject.toml</code>)</h3>
78-
<p>Add one of the following entries under <code>[tool.poetry.dependencies]</code>:</p>
77+
<h3>Using Poetry (<i>pyproject.toml</i>)</h3>
78+
<p>Add one of the following entries under <i>[tool.poetry.dependencies]</i> section:</p>
7979

8080
<ul>
81-
<li><strong>Latest on <code>main</code> branch:</strong><br>
81+
<li><strong>Latest on <i>main</i> branch:</strong><br>
8282
<code>random-names = { git = "https://github.com/navchandar/Python-Random-Name-Generator.git", branch = "main" }</code>
8383
</li>
8484
<li><strong>Specific tag:</strong><br>
8585
<code>random-names = { git = "https://github.com/navchandar/Python-Random-Name-Generator.git", tag = "V4.0" }</code>
8686
</li>
87+
88+
<li>
89+
<p>Then run:</p>
90+
<div class="code-container">
91+
<pre><code id="poetry_install">poetry install</code></pre>
92+
<span class="copy-icon" onclick="copyToClipboard('poetry_install')"
93+
title="Copy Command">📋</span>
94+
</div>
95+
</li>
8796
</ul>
97+
</section>
8898

89-
<p>Then run:</p>
99+
<section>
100+
<h2>Usage</h2>
90101
<div class="code-container">
91-
<pre><code id="poetry_install">poetry install</code></pre>
92-
<span class="copy-icon" onclick="copyToClipboard('poetry_install')" title="Copy Command">📋</span>
102+
<pre><code id="code-full"><span class="comment"># outputs random first and last name</span>
103+
import random_names
104+
random_names.Full()</code></pre>
105+
<span class="copy-icon" onclick="copyToClipboard('code-full')" title="Copy Command">📋</span>
93106
</div>
94107

95-
</section>
108+
<div class="code-container">
109+
<pre><code id="code-first"><span class="comment"># outputs random first name</span>
110+
random_names.First()</code></pre>
111+
<span class="copy-icon" onclick="copyToClipboard('code-first')" title="Copy Command">📋</span>
112+
</div>
113+
114+
<div class="code-container">
115+
<pre><code id="code-middle"><span class="comment"># outputs random middle name</span>
116+
random_names.Middle()</code></pre>
117+
<span class="copy-icon" onclick="copyToClipboard('code-middle')" title="Copy Command">📋</span>
118+
</div>
119+
120+
<div class="code-container">
121+
<pre><code id="code-last"><span class="comment"># outputs random last name</span>
122+
random_names.Last()</code></pre>
123+
<span class="copy-icon" onclick="copyToClipboard('code-last')" title="Copy Command">📋</span>
124+
</div>
125+
126+
<div class="code-container">
127+
<pre><code id="code-company"><span class="comment"># outputs random company name</span>
128+
random_names.Company()</code></pre>
129+
<span class="copy-icon" onclick="copyToClipboard('code-company')" title="Copy Command">📋</span>
130+
</div>
131+
132+
<div class="code-container">
133+
<pre><code id="code-address"><span class="comment"># outputs random Address</span>
134+
random_names.Address()</code></pre>
135+
<span class="copy-icon" onclick="copyToClipboard('code-address')" title="Copy Command">📋</span>
136+
</div>
137+
138+
<div class="code-container">
139+
<pre><code id="code-statecode"><span class="comment"># outputs random US State Code</span>
140+
random_names.StateCode()</code></pre>
141+
<span class="copy-icon" onclick="copyToClipboard('code-statecode')" title="Copy Command">📋</span>
142+
</div>
143+
144+
<div class="code-container">
145+
<pre><code id="code-states"><span class="comment"># outputs random US State name</span>
146+
random_names.States()</code></pre>
147+
<span class="copy-icon" onclick="copyToClipboard('code-states')" title="Copy Command">📋</span>
148+
</div>
149+
150+
<div class="code-container">
151+
<pre><code id="code-country"><span class="comment"># outputs random Country name</span>
152+
random_names.Country()</code></pre>
153+
<span class="copy-icon" onclick="copyToClipboard('code-country')" title="Copy Command">📋</span>
154+
</div>
155+
156+
<div class="code-container">
157+
<pre><code id="code-places"><span class="comment"># outputs random Place name</span>
158+
random_names.Places()</code></pre>
159+
<span class="copy-icon" onclick="copyToClipboard('code-places')" title="Copy Command">📋</span>
160+
</div>
96161

97-
<section>
98-
<h2>Usage</h2>
99-
<pre><code>import random_names
100-
random_names.First() # outputs random first name
101-
random_names.Middle() # outputs random middle name
102-
random_names.Last() # outputs random last name
103-
random_names.Full() # outputs random first and last name
104-
random_names.Company() # outputs random company name
105-
random_names.Address() # outputs random Address
106-
random_names.StateCode() # outputs random US State Code
107-
random_names.States() # outputs random US State name
108-
random_names.Country() # outputs random Country name
109-
random_names.Places() # outputs random Place name</code></pre>
110162
</section>
111163
</main>
112164
<br>

0 commit comments

Comments
 (0)